compass_api_sdk 0.9.44__tar.gz → 0.9.45__tar.gz

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.9.44
+Version: 0.9.45
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/pyproject.toml

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

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/src/compass_api_sdk/_version.py

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

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/src/compass_api_sdk/models/__init__.py

@@ -738,6 +738,7 @@ if TYPE_CHECKING:
         TokenPriceRequest,
         TokenPriceRequestTypedDict,
         TokenPriceToken,
+        TokenPriceTokenTypedDict,
     )
     from .tokenaddressresponse import (
         TokenAddressResponse,
@@ -1526,6 +1527,7 @@ __all__ = [
     "TokenPriceResponse",
     "TokenPriceResponseTypedDict",
     "TokenPriceToken",
+    "TokenPriceTokenTypedDict",
     "TokenSymbol",
     "TokenSymbolTypedDict",
     "TokenTransferErc20Params",
@@ -2234,6 +2236,7 @@ _dynamic_imports: dict[str, str] = {
     "TokenPriceRequest": ".token_priceop",
     "TokenPriceRequestTypedDict": ".token_priceop",
     "TokenPriceToken": ".token_priceop",
+    "TokenPriceTokenTypedDict": ".token_priceop",
     "TokenAddressResponse": ".tokenaddressresponse",
     "TokenAddressResponseTypedDict": ".tokenaddressresponse",
     "TokenBalanceResponse": ".tokenbalanceresponse",

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/src/compass_api_sdk/models/token_priceop.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .token_enum import TokenEnum
 from compass_api_sdk.types import (
     BaseModel,
     Nullable,
@@ -11,7 +12,8 @@ from compass_api_sdk.types import (
 from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
 from enum import Enum
 from pydantic import model_serializer
-from typing_extensions import Annotated, NotRequired, TypedDict
+from typing import Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 class TokenPriceChain(str, Enum):
@@ -22,69 +24,32 @@ class TokenPriceChain(str, Enum):
     ARBITRUM_MAINNET = "arbitrum:mainnet"
 
 
-class TokenPriceToken(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"
+TokenPriceTokenTypedDict = TypeAliasType(
+    "TokenPriceTokenTypedDict", Union[TokenEnum, str]
+)
+r"""The symbol or address of the token for which to get the price."""
+
+
+TokenPriceToken = TypeAliasType("TokenPriceToken", Union[TokenEnum, str])
+r"""The symbol or address of the token for which to get the price."""
 
 
 class TokenPriceRequestTypedDict(TypedDict):
+    token: TokenPriceTokenTypedDict
+    r"""The symbol or address of the token for which to get the price."""
     chain: TokenPriceChain
     r"""The chain to use."""
     block: NotRequired[Nullable[int]]
     r"""Optional block number (defaults to latest)."""
-    token: TokenPriceToken
-    r"""The symbol of the token for which to get the price."""
 
 
 class TokenPriceRequest(BaseModel):
+    token: Annotated[
+        TokenPriceToken,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The symbol or address of the token for which to get the price."""
+
     chain: Annotated[
         TokenPriceChain,
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -97,12 +62,6 @@ class TokenPriceRequest(BaseModel):
     ] = UNSET
     r"""Optional block number (defaults to latest)."""
 
-    token: Annotated[
-        TokenPriceToken,
-        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
-    ] = TokenPriceToken.AAVE
-    r"""The symbol of the token for which to get the price."""
-
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = ["block"]

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/src/compass_api_sdk/sky.py

@@ -202,7 +202,7 @@ class Sky(BaseSDK):
         'SkyDaiUsdsConverter' contract beforehand.
 
         If buying with USDC, user will need to set an allowance on the USDC contract for the
-        'SkyDaiUsdsConverter' contract beforehand.
+        'SkyUsdcUsdsConverter' 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'.
@@ -304,7 +304,7 @@ class Sky(BaseSDK):
         'SkyDaiUsdsConverter' contract beforehand.
 
         If buying with USDC, user will need to set an allowance on the USDC contract for the
-        'SkyDaiUsdsConverter' contract beforehand.
+        'SkyUsdcUsdsConverter' 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'.
@@ -610,7 +610,9 @@ class Sky(BaseSDK):
     ) -> models.TxResponse:
         r"""Deposit USDS
 
-        Deposit USDS for sUSDS to earn yield.
+        Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+
+        Allowance must be set on USDS contract for UsdsVault.
 
         There are no fees.
 
@@ -710,7 +712,9 @@ class Sky(BaseSDK):
     ) -> models.TxResponse:
         r"""Deposit USDS
 
-        Deposit USDS for sUSDS to earn yield.
+        Deposit USDS to earn yield. Deposited USDS is represented as sUSDS.
+
+        Allowance must be set on USDS contract for UsdsVault.
 
         There are no fees.
 
@@ -808,7 +812,11 @@ class Sky(BaseSDK):
     ) -> models.TxResponse:
         r"""Withdraw USDS
 
-        Withdraw USDS for sUSDS to stop earning yield.
+        Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+
+        Allowance must be set on USDS contract for UsdsVault.
+
+        There are no fees.
 
         :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
         :param sender: The address of the transaction sender.
@@ -904,7 +912,11 @@ class Sky(BaseSDK):
     ) -> models.TxResponse:
         r"""Withdraw USDS
 
-        Withdraw USDS for sUSDS to stop earning yield.
+        Withdraw USDS. Exchange yield-bearing sUSDS for USDS.
+
+        Allowance must be set on USDS contract for UsdsVault.
+
+        There are no fees.
 
         :param amount: The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn.
         :param sender: The address of the transaction sender.

{compass_api_sdk-0.9.44 → compass_api_sdk-0.9.45}/src/compass_api_sdk/token_sdk.py

@@ -193,7 +193,7 @@ class TokenSDK(BaseSDK):
         self,
         *,
         chain: models.TokenPriceChain = models.TokenPriceChain.ETHEREUM_MAINNET,
-        token: models.TokenPriceToken = models.TokenPriceToken.AAVE,
+        token: Union[models.TokenPriceToken, models.TokenPriceTokenTypedDict],
         block: OptionalNullable[int] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -209,7 +209,7 @@ class TokenSDK(BaseSDK):
         with the update frequency of the oracle.
 
         :param chain: The chain to use.
-        :param token: The symbol of the token for which to get the price.
+        :param token: The symbol or address of the token for which to get the price.
         :param block: Optional block number (defaults to latest).
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
@@ -290,7 +290,7 @@ class TokenSDK(BaseSDK):
         self,
         *,
         chain: models.TokenPriceChain = models.TokenPriceChain.ETHEREUM_MAINNET,
-        token: models.TokenPriceToken = models.TokenPriceToken.AAVE,
+        token: Union[models.TokenPriceToken, models.TokenPriceTokenTypedDict],
         block: OptionalNullable[int] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -306,7 +306,7 @@ class TokenSDK(BaseSDK):
         with the update frequency of the oracle.
 
         :param chain: The chain to use.
-        :param token: The symbol of the token for which to get the price.
+        :param token: The symbol or address of the token for which to get the price.
         :param block: Optional block number (defaults to latest).
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method