compass_api_sdk 0.1.11__tar.gz → 0.1.13__tar.gz

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.1.11
+Version: 0.1.13
 Summary: Compass API Python SDK
 Author: royalnine
 Requires-Python: >=3.9
@@ -135,7 +135,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
     # Handle response
     print(res)
@@ -155,7 +155,7 @@ async def main():
         api_key_auth="<YOUR_API_KEY_HERE>",
     ) as cas_client:
 
-        res = await cas_client.aave_v3.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = await cas_client.aave_v3.rate_async(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
         # Handle response
         print(res)
@@ -184,7 +184,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
     # Handle response
     print(res)
@@ -200,6 +200,7 @@ with CompassAPISDK(
 
 ### [aave_v3](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md)
 
+* [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
 * [user_position_summary](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#user_position_summary) - Positions - total
@@ -297,7 +298,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -316,7 +317,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
     # Handle response
     print(res)
@@ -338,7 +339,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 `token_price_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 `rate_async` method may raise the following exceptions:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -357,7 +358,7 @@ with CompassAPISDK(
     res = None
     try:
 
-        res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
         # Handle response
         print(res)
@@ -386,7 +387,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
     # Handle response
     print(res)

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/README-PYPI.md

@@ -118,7 +118,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.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.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = await cas_client.aave_v3.rate_async(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.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.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.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)
 
+* [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
 * [user_position_summary](https://github.com/CompassLabs/mono/blob/master/docs/sdks/aavev3/README.md#user_position_summary) - Positions - total
@@ -280,7 +281,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -299,7 +300,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
     # Handle response
     print(res)
@@ -321,7 +322,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 `token_price_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 `rate_async` method may raise the following exceptions:
 
 | Error Type                 | Status Code | Content Type     |
 | -------------------------- | ----------- | ---------------- |
@@ -340,7 +341,7 @@ with CompassAPISDK(
     res = None
     try:
 
-        res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+        res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
         # Handle response
         print(res)
@@ -369,7 +370,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
+    res = cas_client.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)
 
     # Handle response
     print(res)

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compass_api_sdk"
-version = "0.1.11"
+version = "0.1.13"
 description = "Compass API Python SDK"
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/src/compass_api_sdk/_version.py

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

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/src/compass_api_sdk/aave_v3.py

@@ -8,6 +8,232 @@ from typing import Any, Mapping, Optional, Union
 
 
 class AaveV3(BaseSDK):
+    def rate(
+        self,
+        *,
+        chain: models.AaveRateChain = models.AaveRateChain.ARBITRUM_MAINNET,
+        token: models.AaveRateToken = models.AaveRateToken.USDC,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AaveRateResponse:
+        r"""Interest rates
+
+        Returns the latest APY and APR rates for a specified token on Aave, for both
+        deposits and loans.
+
+        **Annual percentage yield (APY)** is the yearly return/cost after continuous
+        compounding of the per-second rate stored on-chain. This value is the same value as
+        seen the on [app.aave.com](
+        https://app.aave.com/)
+        but more up-to-date as it is taken directly from the
+        blockchain every time this endpoint is called.
+
+        **Annual percentage rate (APR)** is the yearly simple interest rate (no
+        compounding).
+
+        For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+
+        :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.AaveRateRequest(
+            chain=chain,
+            token=token,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v0/aave/rate/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_rate",
+                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.AaveRateResponse)
+        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 rate_async(
+        self,
+        *,
+        chain: models.AaveRateChain = models.AaveRateChain.ARBITRUM_MAINNET,
+        token: models.AaveRateToken = models.AaveRateToken.USDC,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.AaveRateResponse:
+        r"""Interest rates
+
+        Returns the latest APY and APR rates for a specified token on Aave, for both
+        deposits and loans.
+
+        **Annual percentage yield (APY)** is the yearly return/cost after continuous
+        compounding of the per-second rate stored on-chain. This value is the same value as
+        seen the on [app.aave.com](
+        https://app.aave.com/)
+        but more up-to-date as it is taken directly from the
+        blockchain every time this endpoint is called.
+
+        **Annual percentage rate (APR)** is the yearly simple interest rate (no
+        compounding).
+
+        For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.
+
+        :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.AaveRateRequest(
+            chain=chain,
+            token=token,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v0/aave/rate/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_rate",
+                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.AaveRateResponse)
+        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 token_price(
         self,
         *,

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/src/compass_api_sdk/models/__init__.py

@@ -11,6 +11,12 @@ from .aave_liquidity_changeop import (
     AaveLiquidityChangeRequestTypedDict,
     AaveLiquidityChangeToken,
 )
+from .aave_rateop import (
+    AaveRateChain,
+    AaveRateRequest,
+    AaveRateRequestTypedDict,
+    AaveRateToken,
+)
 from .aave_token_priceop import (
     AaveTokenPriceChain,
     AaveTokenPriceRequest,
@@ -52,6 +58,7 @@ from .aaveliquiditychangeresponse import (
     AaveLiquidityChangeResponse,
     AaveLiquidityChangeResponseTypedDict,
 )
+from .aaverateresponse import AaveRateResponse, AaveRateResponseTypedDict
 from .aaverepayparams import (
     AaveRepayParams,
     AaveRepayParamsAmount,
@@ -732,6 +739,12 @@ __all__ = [
     "AaveLiquidityChangeResponse",
     "AaveLiquidityChangeResponseTypedDict",
     "AaveLiquidityChangeToken",
+    "AaveRateChain",
+    "AaveRateRequest",
+    "AaveRateRequestTypedDict",
+    "AaveRateResponse",
+    "AaveRateResponseTypedDict",
+    "AaveRateToken",
     "AaveRepayParams",
     "AaveRepayParamsAmount",
     "AaveRepayParamsAmountTypedDict",

compass_api_sdk-0.1.13/src/compass_api_sdk/models/aave_rateop.py

@@ -0,0 +1,97 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+from typing_extensions import Annotated, TypedDict
+
+
+class AaveRateChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class AaveRateToken(str, Enum):
+    r"""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.
+    """
+
+    ONE_INCH = "1INCH"
+    AAVE = "AAVE"
+    BAL = "BAL"
+    CB_BTC = "cbBTC"
+    CB_ETH = "cbETH"
+    CRV = "CRV"
+    CRV_USD = "crvUSD"
+    DAI = "DAI"
+    ENS = "ENS"
+    ET_HX = "ETHx"
+    FRAX = "FRAX"
+    FXS = "FXS"
+    GHO = "GHO"
+    KNC = "KNC"
+    LDO = "LDO"
+    LINK = "LINK"
+    LUSD = "LUSD"
+    MKR = "MKR"
+    OS_ETH = "osETH"
+    PYUSD = "PYUSD"
+    R_ETH = "rETH"
+    RPL = "RPL"
+    RS_ETH = "rsETH"
+    S_DAI = "sDAI"
+    SNX = "SNX"
+    STG = "STG"
+    S_US_DE = "sUSDe"
+    T_BTC = "tBTC"
+    UNI = "UNI"
+    USDC = "USDC"
+    US_DE = "USDe"
+    USDS = "USDS"
+    USDT = "USDT"
+    WBTC = "WBTC"
+    WE_ETH = "weETH"
+    WETH = "WETH"
+    WST_ETH = "wstETH"
+    ARB = "ARB"
+    EURS = "EURS"
+    MAI = "MAI"
+    USD_CE = "USDCe"
+    AERO = "AERO"
+    EUR = "EUR"
+    VIRTUAL = "VIRTUAL"
+
+
+class AaveRateRequestTypedDict(TypedDict):
+    chain: AaveRateChain
+    r"""The chain to use."""
+    token: AaveRateToken
+    r"""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.
+    """
+
+
+class AaveRateRequest(BaseModel):
+    chain: Annotated[
+        AaveRateChain,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveRateChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token: Annotated[
+        AaveRateToken,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveRateToken.USDC
+    r"""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.
+    """

compass_api_sdk-0.1.13/src/compass_api_sdk/models/aaverateresponse.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class AaveRateResponseTypedDict(TypedDict):
+    supply_apy_variable_rate: str
+    r"""Variable rate APY for deposits."""
+    supply_apr_variable_rate: str
+    r"""Variable rate APR for deposits."""
+    borrow_apy_variable_rate: str
+    r"""Variable rate APY for loans."""
+    borrow_apr_variable_rate: str
+    r"""Variable rate APR for loans."""
+    borrow_apy_fixed_rate: str
+    r"""Fixed rate APY for loans."""
+    borrow_apr_fixed_rate: str
+    r"""Fixed rate APR for loans."""
+
+
+class AaveRateResponse(BaseModel):
+    supply_apy_variable_rate: str
+    r"""Variable rate APY for deposits."""
+
+    supply_apr_variable_rate: str
+    r"""Variable rate APR for deposits."""
+
+    borrow_apy_variable_rate: str
+    r"""Variable rate APY for loans."""
+
+    borrow_apr_variable_rate: str
+    r"""Variable rate APR for loans."""
+
+    borrow_apy_fixed_rate: str
+    r"""Fixed rate APY for loans."""
+
+    borrow_apr_fixed_rate: str
+    r"""Fixed rate APR for loans."""

{compass_api_sdk-0.1.11 → compass_api_sdk-0.1.13}/src/compass_api_sdk/sky.py

@@ -215,9 +215,13 @@ class Sky(BaseSDK):
     ) -> models.UnsignedTransaction:
         r"""Buy USDS
 
-        Buy USDS with DAI or USDC on a 1:1 basis.
+        Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
 
-        There are no fees.
+        If buying with DAI, user will need to set an allowance on the DAI contract for the
+        'SkyDaiUsdsConverter' contract beforehand.
+
+        If buying with USDC, user will need to set an allowance on the USDC contract for the
+        'SkyDaiUsdsConverter' contract beforehand.
 
         :param token_in: The token you would like to swap 1:1 for USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to buy 1:1 with 'token_in'.
@@ -323,9 +327,13 @@ class Sky(BaseSDK):
     ) -> models.UnsignedTransaction:
         r"""Buy USDS
 
-        Buy USDS with DAI or USDC on a 1:1 basis.
+        Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.
 
-        There are no fees.
+        If buying with DAI, user will need to set an allowance on the DAI contract for the
+        'SkyDaiUsdsConverter' contract beforehand.
+
+        If buying with USDC, user will need to set an allowance on the USDC contract for the
+        'SkyDaiUsdsConverter' contract beforehand.
 
         :param token_in: The token you would like to swap 1:1 for USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to buy 1:1 with 'token_in'.
@@ -433,9 +441,13 @@ class Sky(BaseSDK):
     ) -> models.UnsignedTransaction:
         r"""Sell USDS
 
-        Sell USDS for DAI or USDC on a 1:1 basis.
+        Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
 
-        There are no fees.
+        If swapping to DAI, user will need to set an allowance on the USDS contract for the
+        'SkyDaiUsdsConverter' contract beforehand.
+
+        If swapping to USDC, user will need to set an allowance on the USDS contract for the
+        'SkyUsdcUsdsConverter' contract beforehand.
 
         :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.
@@ -543,9 +555,13 @@ class Sky(BaseSDK):
     ) -> models.UnsignedTransaction:
         r"""Sell USDS
 
-        Sell USDS for DAI or USDC on a 1:1 basis.
+        Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.
 
-        There are no fees.
+        If swapping to DAI, user will need to set an allowance on the USDS contract for the
+        'SkyDaiUsdsConverter' contract beforehand.
+
+        If swapping to USDC, user will need to set an allowance on the USDS contract for the
+        'SkyUsdcUsdsConverter' contract beforehand.
 
         :param token_out: The token you would like to swap 1:1 with USDS. Choose from DAI or USDC.
         :param amount: The amount of USDS you would like to sell 1:1 for 'token_out'.