compass_api_sdk 0.0.1__py3-none-any.whl

compass_api_sdk/models/aave_liquidity_changeop.py

@@ -0,0 +1,108 @@
+"""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 import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AaveLiquidityChangeChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class AaveLiquidityChangeToken(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 AaveLiquidityChangeRequestTypedDict(TypedDict):
+    chain: NotRequired[AaveLiquidityChangeChain]
+    r"""The chain to use."""
+    token: NotRequired[AaveLiquidityChangeToken]
+    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.
+    """
+    start_block: int
+    end_block: int
+
+
+class AaveLiquidityChangeRequest(BaseModel):
+    chain: Annotated[
+        Optional[AaveLiquidityChangeChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveLiquidityChangeChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token: Annotated[
+        Optional[AaveLiquidityChangeToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveLiquidityChangeToken.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.
+    """
+
+    start_block: Annotated[
+        int, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = 0
+
+    end_block: Annotated[
+        int, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = 319407231

compass_api_sdk/models/aave_token_priceop.py

@@ -0,0 +1,98 @@
+"""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 import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AaveTokenPriceChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class AaveTokenPriceToken(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 AaveTokenPriceRequestTypedDict(TypedDict):
+    chain: NotRequired[AaveTokenPriceChain]
+    r"""The chain to use."""
+    token: NotRequired[AaveTokenPriceToken]
+    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 AaveTokenPriceRequest(BaseModel):
+    chain: Annotated[
+        Optional[AaveTokenPriceChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveTokenPriceChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    token: Annotated[
+        Optional[AaveTokenPriceToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveTokenPriceToken.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/models/aave_user_position_per_tokenop.py

@@ -0,0 +1,104 @@
+"""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 import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AaveUserPositionPerTokenChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class AaveUserPositionPerTokenToken(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 AaveUserPositionPerTokenRequestTypedDict(TypedDict):
+    chain: NotRequired[AaveUserPositionPerTokenChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+    token: NotRequired[AaveUserPositionPerTokenToken]
+    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 AaveUserPositionPerTokenRequest(BaseModel):
+    chain: Annotated[
+        Optional[AaveUserPositionPerTokenChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveUserPositionPerTokenChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
+
+    token: Annotated[
+        Optional[AaveUserPositionPerTokenToken],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveUserPositionPerTokenToken.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/models/aave_user_position_summaryop.py

@@ -0,0 +1,35 @@
+"""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 import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class AaveUserPositionSummaryChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+class AaveUserPositionSummaryRequestTypedDict(TypedDict):
+    chain: NotRequired[AaveUserPositionSummaryChain]
+    r"""The chain to use."""
+    user: NotRequired[str]
+
+
+class AaveUserPositionSummaryRequest(BaseModel):
+    chain: Annotated[
+        Optional[AaveUserPositionSummaryChain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = AaveUserPositionSummaryChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    user: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

compass_api_sdk/models/aaveborrowrequest.py

@@ -0,0 +1,105 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .interestratemode import InterestRateMode
+from .token_enum import TokenEnum
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AaveBorrowRequestAmountTypedDict = TypeAliasType(
+    "AaveBorrowRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of the asset to borrow"""
+
+
+AaveBorrowRequestAmount = TypeAliasType("AaveBorrowRequestAmount", Union[float, str])
+r"""The amount of the asset to borrow"""
+
+
+class AaveBorrowRequestTypedDict(TypedDict):
+    token: TokenEnum
+    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.
+    """
+    amount: AaveBorrowRequestAmountTypedDict
+    r"""The amount of the asset to borrow"""
+    interest_rate_mode: InterestRateMode
+    r"""On AAVE there are 2 different interest modes.
+
+    A stable (but typically higher rate), or a variable rate.
+    """
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    on_behalf_of: NotRequired[Nullable[str]]
+    r"""The address on behalf of whom the supply is made"""
+
+
+class AaveBorrowRequest(BaseModel):
+    token: TokenEnum
+    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.
+    """
+
+    amount: AaveBorrowRequestAmount
+    r"""The amount of the asset to borrow"""
+
+    interest_rate_mode: InterestRateMode
+    r"""On AAVE there are 2 different interest modes.
+
+    A stable (but typically higher rate), or a variable rate.
+    """
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    on_behalf_of: OptionalNullable[str] = UNSET
+    r"""The address on behalf of whom the supply is made"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["on_behalf_of"]
+        nullable_fields = ["on_behalf_of"]
+        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

compass_api_sdk/models/aaveliquiditychangeresponse.py

@@ -0,0 +1,26 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from datetime import datetime
+from typing_extensions import TypedDict
+
+
+class AaveLiquidityChangeResponseTypedDict(TypedDict):
+    liquidity_change: str
+    r"""The change in the liquidity index between the two times, expressed as a percentage."""
+    start_time: datetime
+    r"""Dateime of starting block"""
+    end_time: datetime
+    r"""Dateime of ending block"""
+
+
+class AaveLiquidityChangeResponse(BaseModel):
+    liquidity_change: str
+    r"""The change in the liquidity index between the two times, expressed as a percentage."""
+
+    start_time: datetime
+    r"""Dateime of starting block"""
+
+    end_time: datetime
+    r"""Dateime of ending block"""

compass_api_sdk/models/aaverepayrequest.py

@@ -0,0 +1,105 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .interestratemode import InterestRateMode
+from .token_enum import TokenEnum
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AaveRepayRequestAmountTypedDict = TypeAliasType(
+    "AaveRepayRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of the asset to repay"""
+
+
+AaveRepayRequestAmount = TypeAliasType("AaveRepayRequestAmount", Union[float, str])
+r"""The amount of the asset to repay"""
+
+
+class AaveRepayRequestTypedDict(TypedDict):
+    token: TokenEnum
+    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.
+    """
+    amount: AaveRepayRequestAmountTypedDict
+    r"""The amount of the asset to repay"""
+    interest_rate_mode: InterestRateMode
+    r"""On AAVE there are 2 different interest modes.
+
+    A stable (but typically higher rate), or a variable rate.
+    """
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    on_behalf_of: NotRequired[Nullable[str]]
+    r"""The address on behalf of whom the supply is made"""
+
+
+class AaveRepayRequest(BaseModel):
+    token: TokenEnum
+    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.
+    """
+
+    amount: AaveRepayRequestAmount
+    r"""The amount of the asset to repay"""
+
+    interest_rate_mode: InterestRateMode
+    r"""On AAVE there are 2 different interest modes.
+
+    A stable (but typically higher rate), or a variable rate.
+    """
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    on_behalf_of: OptionalNullable[str] = UNSET
+    r"""The address on behalf of whom the supply is made"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["on_behalf_of"]
+        nullable_fields = ["on_behalf_of"]
+        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

compass_api_sdk/models/aavesupplyrequest.py

@@ -0,0 +1,93 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from .token_enum import TokenEnum
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import NotRequired, TypeAliasType, TypedDict
+
+
+AaveSupplyRequestAmountTypedDict = TypeAliasType(
+    "AaveSupplyRequestAmountTypedDict", Union[float, str]
+)
+r"""The amount of the asset to supply"""
+
+
+AaveSupplyRequestAmount = TypeAliasType("AaveSupplyRequestAmount", Union[float, str])
+r"""The amount of the asset to supply"""
+
+
+class AaveSupplyRequestTypedDict(TypedDict):
+    token: TokenEnum
+    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.
+    """
+    amount: AaveSupplyRequestAmountTypedDict
+    r"""The amount of the asset to supply"""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    on_behalf_of: NotRequired[Nullable[str]]
+    r"""The address on behalf of whom the supply is made. Defaults to the transaction sender."""
+
+
+class AaveSupplyRequest(BaseModel):
+    token: TokenEnum
+    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.
+    """
+
+    amount: AaveSupplyRequestAmount
+    r"""The amount of the asset to supply"""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    on_behalf_of: OptionalNullable[str] = UNSET
+    r"""The address on behalf of whom the supply is made. Defaults to the transaction sender."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["on_behalf_of"]
+        nullable_fields = ["on_behalf_of"]
+        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

compass_api_sdk/models/aavetokenpriceresponse.py

@@ -0,0 +1,15 @@
+"""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 AaveTokenPriceResponseTypedDict(TypedDict):
+    price: str
+    r"""The price of the asset in USD."""
+
+
+class AaveTokenPriceResponse(BaseModel):
+    price: str
+    r"""The price of the asset in USD."""