compass_api_sdk 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

compassapisdk/models/skysellparams.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import BaseModel
+from enum import Enum
+from typing import Union
+from typing_extensions import TypeAliasType, TypedDict
+
+
+class SkySellParamsTokenOut(str, Enum):
+    r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
+
+    DAI = "DAI"
+    USDC = "USDC"
+
+
+SkySellParamsAmountTypedDict = TypeAliasType(
+    "SkySellParamsAmountTypedDict", Union[float, str]
+)
+r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+
+
+SkySellParamsAmount = TypeAliasType("SkySellParamsAmount", Union[float, str])
+r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+
+
+class SkySellParamsTypedDict(TypedDict):
+    token_out: SkySellParamsTokenOut
+    r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
+    amount: SkySellParamsAmountTypedDict
+    r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
+
+
+class SkySellParams(BaseModel):
+    token_out: SkySellParamsTokenOut
+    r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
+
+    amount: SkySellParamsAmount
+    r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""

compassapisdk/models/skysellrequest.py

@@ -10,7 +10,7 @@ from typing import Literal, Optional, Union
 from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
-class TokenOut(str, Enum):
+class SkySellRequestTokenOut(str, Enum):
     r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
 
     DAI = "DAI"
@@ -28,7 +28,7 @@ r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
 
 
 class SkySellRequestTypedDict(TypedDict):
-    token_out: TokenOut
+    token_out: SkySellRequestTokenOut
     r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
     amount: SkySellRequestAmountTypedDict
     r"""The amount of USDS you would like to sell 1:1 for 'token_out'."""
@@ -38,7 +38,7 @@ class SkySellRequestTypedDict(TypedDict):
 
 
 class SkySellRequest(BaseModel):
-    token_out: TokenOut
+    token_out: SkySellRequestTokenOut
     r"""The token you would like to swap 1:1 with USDS. Choose from DAI or USDC."""
 
     amount: SkySellRequestAmount

compassapisdk/models/skywithdrawparams.py

@@ -0,0 +1,58 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compassapisdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Any
+from typing_extensions import NotRequired, TypedDict
+
+
+class SkyWithdrawParamsTypedDict(TypedDict):
+    amount: Any
+    r"""The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn."""
+    receiver: NotRequired[Nullable[str]]
+    r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
+
+
+class SkyWithdrawParams(BaseModel):
+    amount: Any
+    r"""The amount of USDS you would like to withdraw. If set to 'ALL', your total deposited USDS amount will be withdrawn."""
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address which will receive the withdrawn USDS. Defaults to the sender."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["receiver"]
+        nullable_fields = ["receiver"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compassapisdk/morpho.py

@@ -3,7 +3,7 @@
 from .basesdk import BaseSDK
 from compassapisdk import errors, models, utils
 from compassapisdk._hooks import HookContext
-from compassapisdk.types import OptionalNullable, UNSET
+from compassapisdk.types import Nullable, OptionalNullable, UNSET
 from typing import Any, Mapping, Optional, Union
 
 
@@ -11,10 +11,8 @@ class Morpho(BaseSDK):
     def vaults(
         self,
         *,
-        chain: Optional[
-            models.MorphoVaultsChain
-        ] = models.MorphoVaultsChain.ETHEREUM_MAINNET,
-        deposit_token: OptionalNullable[str] = UNSET,
+        chain: models.MorphoVaultsChain = models.MorphoVaultsChain.ETHEREUM_MAINNET,
+        deposit_token: Nullable[str],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -117,10 +115,8 @@ class Morpho(BaseSDK):
     async def vaults_async(
         self,
         *,
-        chain: Optional[
-            models.MorphoVaultsChain
-        ] = models.MorphoVaultsChain.ETHEREUM_MAINNET,
-        deposit_token: OptionalNullable[str] = UNSET,
+        chain: models.MorphoVaultsChain = models.MorphoVaultsChain.ETHEREUM_MAINNET,
+        deposit_token: Nullable[str],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -223,11 +219,9 @@ class Morpho(BaseSDK):
     def vault_position(
         self,
         *,
+        chain: models.MorphoVaultPositionChain = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         vault_address: str = "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
-        chain: Optional[
-            models.MorphoVaultPositionChain
-        ] = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -238,9 +232,9 @@ class Morpho(BaseSDK):
         Check how many shares you own and the equivalent token amount of a given
         vault.
 
+        :param chain:
         :param user_address: The user address of the desired vault position.
         :param vault_address: The vault address of the desired vault position.
-        :param chain:
         :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
@@ -331,11 +325,9 @@ class Morpho(BaseSDK):
     async def vault_position_async(
         self,
         *,
+        chain: models.MorphoVaultPositionChain = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         vault_address: str = "0xbEef047a543E45807105E51A8BBEFCc5950fcfBa",
-        chain: Optional[
-            models.MorphoVaultPositionChain
-        ] = models.MorphoVaultPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -346,9 +338,9 @@ class Morpho(BaseSDK):
         Check how many shares you own and the equivalent token amount of a given
         vault.
 
+        :param chain:
         :param user_address: The user address of the desired vault position.
         :param vault_address: The vault address of the desired vault position.
-        :param chain:
         :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
@@ -439,11 +431,9 @@ class Morpho(BaseSDK):
     def markets(
         self,
         *,
-        chain: Optional[
-            models.MorphoMarketsChain
-        ] = models.MorphoMarketsChain.ETHEREUM_MAINNET,
-        collateral_token: OptionalNullable[str] = UNSET,
-        loan_token: OptionalNullable[str] = UNSET,
+        chain: models.MorphoMarketsChain = models.MorphoMarketsChain.ETHEREUM_MAINNET,
+        collateral_token: Nullable[str],
+        loan_token: Nullable[str],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -547,11 +537,9 @@ class Morpho(BaseSDK):
     async def markets_async(
         self,
         *,
-        chain: Optional[
-            models.MorphoMarketsChain
-        ] = models.MorphoMarketsChain.ETHEREUM_MAINNET,
-        collateral_token: OptionalNullable[str] = UNSET,
-        loan_token: OptionalNullable[str] = UNSET,
+        chain: models.MorphoMarketsChain = models.MorphoMarketsChain.ETHEREUM_MAINNET,
+        collateral_token: Nullable[str],
+        loan_token: Nullable[str],
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -655,11 +643,9 @@ class Morpho(BaseSDK):
     def market_position(
         self,
         *,
+        chain: models.MorphoMarketPositionChain = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         unique_market_key: str = "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-        chain: Optional[
-            models.MorphoMarketPositionChain
-        ] = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -670,9 +656,9 @@ class Morpho(BaseSDK):
         Check how many shares you've borrowed and the equivalent token amount of a given
         market.
 
+        :param chain:
         :param user_address: The user address of the desired market position.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain:
         :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
@@ -763,11 +749,9 @@ class Morpho(BaseSDK):
     async def market_position_async(
         self,
         *,
+        chain: models.MorphoMarketPositionChain = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         user_address: str = "0xa829B388A3DF7f581cE957a95edbe419dd146d1B",
         unique_market_key: str = "0xe7399fdebc318d76dfec7356caafcf8cd4b91287e139a3ec423f09aeeb656fc4",
-        chain: Optional[
-            models.MorphoMarketPositionChain
-        ] = models.MorphoMarketPositionChain.ETHEREUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -778,9 +762,9 @@ class Morpho(BaseSDK):
         Check how many shares you've borrowed and the equivalent token amount of a given
         market.
 
+        :param chain:
         :param user_address: The user address of the desired market position.
         :param unique_market_key: The key that uniquely identifies the market. This can be found using the 'Get Markets' endpoint.
-        :param chain:
         :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

compassapisdk/sky.py

@@ -205,7 +205,7 @@ class Sky(BaseSDK):
     def buy(
         self,
         *,
-        token_in: models.TokenIn,
+        token_in: models.SkyBuyRequestTokenIn,
         amount: Union[models.SkyBuyRequestAmount, models.SkyBuyRequestAmountTypedDict],
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -317,7 +317,7 @@ class Sky(BaseSDK):
     async def buy_async(
         self,
         *,
-        token_in: models.TokenIn,
+        token_in: models.SkyBuyRequestTokenIn,
         amount: Union[models.SkyBuyRequestAmount, models.SkyBuyRequestAmountTypedDict],
         sender: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -429,7 +429,7 @@ class Sky(BaseSDK):
     def sell(
         self,
         *,
-        token_out: models.TokenOut,
+        token_out: models.SkySellRequestTokenOut,
         amount: Union[
             models.SkySellRequestAmount, models.SkySellRequestAmountTypedDict
         ],
@@ -543,7 +543,7 @@ class Sky(BaseSDK):
     async def sell_async(
         self,
         *,
-        token_out: models.TokenOut,
+        token_out: models.SkySellRequestTokenOut,
         amount: Union[
             models.SkySellRequestAmount, models.SkySellRequestAmountTypedDict
         ],