compass_api_sdk 1.1.1__py3-none-any.whl → 2.2.1rc3__py3-none-any.whl

compass_api_sdk/models/depositforburnresponse.py

@@ -0,0 +1,100 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_output import (
+    BatchedSafeOperationsResponseOutput,
+    BatchedSafeOperationsResponseOutputTypedDict,
+)
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from enum import Enum
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class DepositForBurnResponseTransferMode(str, Enum):
+    r"""The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min)."""
+
+    FAST = "fast"
+    STANDARD = "standard"
+
+
+class DepositForBurnResponseTypedDict(TypedDict):
+    r"""Response model for CCTP depositForBurn transaction from a smart account.
+
+    Contains either an unsigned transaction for direct submission or EIP-712 typed data
+    for gas-sponsored transactions. Also includes a bridge_id for tracking the cross-
+    chain transfer.
+    """
+
+    transaction: Nullable[UnsignedTransactionTypedDict]
+    eip_712: Nullable[BatchedSafeOperationsResponseOutputTypedDict]
+    transfer_mode: DepositForBurnResponseTransferMode
+    r"""The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min)."""
+    estimated_time_seconds: int
+    r"""Estimated time to complete the bridge in seconds."""
+    bridge_id: NotRequired[Nullable[str]]
+    r"""Unique bridge identifier for tracking this cross-chain transfer. Use this ID when calling /mint/prepare to complete the transfer. Only present when Redis is configured on the server."""
+    fee: NotRequired[Nullable[str]]
+    r"""Fee amount in USDC charged for this transfer. Only present for fast mode. Standard mode transfers are free (fee is None or 0)."""
+
+
+class DepositForBurnResponse(BaseModel):
+    r"""Response model for CCTP depositForBurn transaction from a smart account.
+
+    Contains either an unsigned transaction for direct submission or EIP-712 typed data
+    for gas-sponsored transactions. Also includes a bridge_id for tracking the cross-
+    chain transfer.
+    """
+
+    transaction: Nullable[UnsignedTransaction]
+
+    eip_712: Nullable[BatchedSafeOperationsResponseOutput]
+
+    transfer_mode: DepositForBurnResponseTransferMode
+    r"""The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min)."""
+
+    estimated_time_seconds: int
+    r"""Estimated time to complete the bridge in seconds."""
+
+    bridge_id: OptionalNullable[str] = UNSET
+    r"""Unique bridge identifier for tracking this cross-chain transfer. Use this ID when calling /mint/prepare to complete the transfer. Only present when Redis is configured on the server."""
+
+    fee: OptionalNullable[str] = UNSET
+    r"""Fee amount in USDC charged for this transfer. Only present for fast mode. Standard mode transfers are free (fee is None or 0)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["bridge_id", "fee"]
+        nullable_fields = ["bridge_id", "transaction", "eip_712", "fee"]
+        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/earnmanageparams.py

@@ -0,0 +1,76 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .aavevenue import AaveVenue, AaveVenueTypedDict
+from .pendleptvenue import PendlePTVenue, PendlePTVenueTypedDict
+from .vaultvenue import VaultVenue, VaultVenueTypedDict
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import validate_const
+from enum import Enum
+import pydantic
+from pydantic import Field
+from pydantic.functional_validators import AfterValidator
+from typing import Any, Literal, Optional, Union
+from typing_extensions import Annotated, TypeAliasType, TypedDict
+
+
+EarnManageParamsVenueTypedDict = TypeAliasType(
+    "EarnManageParamsVenueTypedDict",
+    Union[VaultVenueTypedDict, AaveVenueTypedDict, PendlePTVenueTypedDict],
+)
+r"""The earn venue."""
+
+
+EarnManageParamsVenue = Annotated[
+    Union[AaveVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
+]
+r"""The earn venue."""
+
+
+class EarnManageParamsAction(str, Enum):
+    r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
+
+    DEPOSIT = "DEPOSIT"
+    WITHDRAW = "WITHDRAW"
+
+
+class EarnManageParamsTypedDict(TypedDict):
+    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave/Pendle PT).
+
+    Used by multicall/bundle endpoint to specify manage actions. EarnManageRequest
+    inherits from this class.
+    """
+
+    venue: EarnManageParamsVenueTypedDict
+    r"""The earn venue."""
+    action: EarnManageParamsAction
+    r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
+    amount: Any
+    r"""Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset; for PENDLE_PT, this is the amount of `token` to spend (DEPOSIT) or PT to sell (WITHDRAW). Provide as a decimal in token units (not wei); must be > 0."""
+    action_type: Literal["V2_MANAGE"]
+    r"""Action type identifier for manage operations."""
+
+
+class EarnManageParams(BaseModel):
+    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave/Pendle PT).
+
+    Used by multicall/bundle endpoint to specify manage actions. EarnManageRequest
+    inherits from this class.
+    """
+
+    venue: EarnManageParamsVenue
+    r"""The earn venue."""
+
+    action: EarnManageParamsAction
+    r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
+
+    amount: Any
+    r"""Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset; for PENDLE_PT, this is the amount of `token` to spend (DEPOSIT) or PT to sell (WITHDRAW). Provide as a decimal in token units (not wei); must be > 0."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["V2_MANAGE"]], AfterValidator(validate_const("V2_MANAGE"))
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "V2_MANAGE"
+    r"""Action type identifier for manage operations."""

compass_api_sdk/models/earnmanagerequest.py

@@ -0,0 +1,132 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .aavevenue import AaveVenue, AaveVenueTypedDict
+from .chain import Chain
+from .fee import Fee, FeeTypedDict
+from .pendleptvenue import PendlePTVenue, PendlePTVenueTypedDict
+from .vaultvenue import VaultVenue, VaultVenueTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compass_api_sdk.utils import validate_const
+from enum import Enum
+import pydantic
+from pydantic import Field, model_serializer
+from pydantic.functional_validators import AfterValidator
+from typing import Any, Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+EarnManageRequestVenueTypedDict = TypeAliasType(
+    "EarnManageRequestVenueTypedDict",
+    Union[VaultVenueTypedDict, AaveVenueTypedDict, PendlePTVenueTypedDict],
+)
+r"""The earn venue."""
+
+
+EarnManageRequestVenue = Annotated[
+    Union[AaveVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
+]
+r"""The earn venue."""
+
+
+class EarnManageRequestAction(str, Enum):
+    r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
+
+    DEPOSIT = "DEPOSIT"
+    WITHDRAW = "WITHDRAW"
+
+
+class EarnManageRequestTypedDict(TypedDict):
+    r"""Request model for the unified manage endpoint.
+
+    Inherits from EarnManageParams and adds context fields (owner, chain, etc).
+    """
+
+    venue: EarnManageRequestVenueTypedDict
+    r"""The earn venue."""
+    action: EarnManageRequestAction
+    r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
+    amount: Any
+    r"""Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset; for PENDLE_PT, this is the amount of `token` to spend (DEPOSIT) or PT to sell (WITHDRAW). Provide as a decimal in token units (not wei); must be > 0."""
+    owner: str
+    r"""The primary wallet address that owns and controls the Earn Account."""
+    chain: Chain
+    r"""The chain to use."""
+    action_type: Literal["V2_MANAGE"]
+    r"""Action type identifier for manage operations."""
+    gas_sponsorship: NotRequired[bool]
+    r"""Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`)."""
+    fee: NotRequired[Nullable[FeeTypedDict]]
+    r"""Optional fee configuration. If provided, a fee will be applied to the transaction amount and sent to the specified recipient address. The fee can be specified as a percentage of the transaction amount or as a fixed token amount."""
+
+
+class EarnManageRequest(BaseModel):
+    r"""Request model for the unified manage endpoint.
+
+    Inherits from EarnManageParams and adds context fields (owner, chain, etc).
+    """
+
+    venue: EarnManageRequestVenue
+    r"""The earn venue."""
+
+    action: EarnManageRequestAction
+    r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
+
+    amount: Any
+    r"""Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault's underlying token; for AAVE, this is the Aave reserve asset; for PENDLE_PT, this is the amount of `token` to spend (DEPOSIT) or PT to sell (WITHDRAW). Provide as a decimal in token units (not wei); must be > 0."""
+
+    owner: str
+    r"""The primary wallet address that owns and controls the Earn Account."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["V2_MANAGE"]], AfterValidator(validate_const("V2_MANAGE"))
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "V2_MANAGE"
+    r"""Action type identifier for manage operations."""
+
+    gas_sponsorship: Optional[bool] = None
+    r"""Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`)."""
+
+    fee: OptionalNullable[Fee] = UNSET
+    r"""Optional fee configuration. If provided, a fee will be applied to the transaction amount and sent to the specified recipient address. The fee can be specified as a percentage of the transaction amount or as a fixed token amount."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["action_type", "gas_sponsorship", "fee"]
+        nullable_fields = ["fee"]
+        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/earnmanageresponse.py

@@ -0,0 +1,52 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_output import (
+    BatchedSafeOperationsResponseOutput,
+    BatchedSafeOperationsResponseOutputTypedDict,
+)
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import BaseModel, Nullable, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import TypedDict
+
+
+class EarnManageResponseTypedDict(TypedDict):
+    transaction: Nullable[UnsignedTransactionTypedDict]
+    eip_712: Nullable[BatchedSafeOperationsResponseOutputTypedDict]
+
+
+class EarnManageResponse(BaseModel):
+    transaction: Nullable[UnsignedTransaction]
+
+    eip_712: Nullable[BatchedSafeOperationsResponseOutput]
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["transaction", "eip_712"]
+        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/earnpositionsresponse.py

@@ -0,0 +1,48 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .aaveposition import AavePosition, AavePositionTypedDict
+from .compass_api_backend_v2_models_earn_read_response_positions_vaultposition import (
+    CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPosition,
+    CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPositionTypedDict,
+)
+from .pendleptposition import PendlePTPosition, PendlePTPositionTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class EarnPositionsResponseTypedDict(TypedDict):
+    r"""Grouped positions by protocol.
+
+    This new structure groups positions by protocol type for better organization and
+    removes the need for a discriminated union in SDK consumers.
+    """
+
+    aave: NotRequired[List[AavePositionTypedDict]]
+    r"""Aave V3 lending positions."""
+    vaults: NotRequired[
+        List[CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPositionTypedDict]
+    ]
+    r"""ERC-4626 vault positions."""
+    pendle_pt: NotRequired[List[PendlePTPositionTypedDict]]
+    r"""Pendle Principal Token positions."""
+
+
+class EarnPositionsResponse(BaseModel):
+    r"""Grouped positions by protocol.
+
+    This new structure groups positions by protocol type for better organization and
+    removes the need for a discriminated union in SDK consumers.
+    """
+
+    aave: Optional[List[AavePosition]] = None
+    r"""Aave V3 lending positions."""
+
+    vaults: Optional[
+        List[CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPosition]
+    ] = None
+    r"""ERC-4626 vault positions."""
+
+    pendle_pt: Optional[List[PendlePTPosition]] = None
+    r"""Pendle Principal Token positions."""

compass_api_sdk/models/earnswapparams.py

@@ -0,0 +1,74 @@
+"""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 validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+EarnSwapParamsAmountInTypedDict = TypeAliasType(
+    "EarnSwapParamsAmountInTypedDict", Union[float, str]
+)
+r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+
+
+EarnSwapParamsAmountIn = TypeAliasType("EarnSwapParamsAmountIn", Union[float, str])
+r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+
+
+EarnSwapParamsSlippageTypedDict = TypeAliasType(
+    "EarnSwapParamsSlippageTypedDict", Union[float, str]
+)
+r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+
+
+EarnSwapParamsSlippage = TypeAliasType("EarnSwapParamsSlippage", Union[float, str])
+r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+
+
+class EarnSwapParamsTypedDict(TypedDict):
+    r"""Parameters for swap operations (without context like owner/chain).
+
+    Used by multicall/bundle endpoint to specify swap actions.
+    """
+
+    token_in: str
+    r"""Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address."""
+    token_out: str
+    r"""Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address."""
+    amount_in: EarnSwapParamsAmountInTypedDict
+    r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+    action_type: Literal["V2_SWAP"]
+    r"""Action type identifier for swap operations."""
+    slippage: NotRequired[EarnSwapParamsSlippageTypedDict]
+    r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+
+
+class EarnSwapParams(BaseModel):
+    r"""Parameters for swap operations (without context like owner/chain).
+
+    Used by multicall/bundle endpoint to specify swap actions.
+    """
+
+    token_in: str
+    r"""Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address."""
+
+    token_out: str
+    r"""Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address."""
+
+    amount_in: EarnSwapParamsAmountIn
+    r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["V2_SWAP"]], AfterValidator(validate_const("V2_SWAP"))
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "V2_SWAP"
+    r"""Action type identifier for swap operations."""
+
+    slippage: Optional[EarnSwapParamsSlippage] = None
+    r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""

compass_api_sdk/models/earnswaprequest.py

@@ -0,0 +1,90 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional, Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+EarnSwapRequestAmountInTypedDict = TypeAliasType(
+    "EarnSwapRequestAmountInTypedDict", Union[float, str]
+)
+r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+
+
+EarnSwapRequestAmountIn = TypeAliasType("EarnSwapRequestAmountIn", Union[float, str])
+r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+
+
+EarnSwapRequestSlippageTypedDict = TypeAliasType(
+    "EarnSwapRequestSlippageTypedDict", Union[float, str]
+)
+r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+
+
+EarnSwapRequestSlippage = TypeAliasType("EarnSwapRequestSlippage", Union[float, str])
+r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+
+
+class EarnSwapRequestTypedDict(TypedDict):
+    r"""Request model for swap endpoint.
+
+    Inherits swap params and adds context fields (owner, chain, gas_sponsorship).
+    """
+
+    token_in: str
+    r"""Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address."""
+    token_out: str
+    r"""Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address."""
+    amount_in: EarnSwapRequestAmountInTypedDict
+    r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+    owner: str
+    r"""The owner's wallet address."""
+    chain: Chain
+    r"""The chain to use."""
+    action_type: Literal["V2_SWAP"]
+    r"""Action type identifier for swap operations."""
+    slippage: NotRequired[EarnSwapRequestSlippageTypedDict]
+    r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+    gas_sponsorship: NotRequired[bool]
+    r"""Optionally request gas sponsorship. If `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`)."""
+
+
+class EarnSwapRequest(BaseModel):
+    r"""Request model for swap endpoint.
+
+    Inherits swap params and adds context fields (owner, chain, gas_sponsorship).
+    """
+
+    token_in: str
+    r"""Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address."""
+
+    token_out: str
+    r"""Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address."""
+
+    amount_in: EarnSwapRequestAmountIn
+    r"""Human-readable amount of `token_in` to swap (token units, not wei)."""
+
+    owner: str
+    r"""The owner's wallet address."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["V2_SWAP"]], AfterValidator(validate_const("V2_SWAP"))
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "V2_SWAP"
+    r"""Action type identifier for swap operations."""
+
+    slippage: Optional[EarnSwapRequestSlippage] = None
+    r"""Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%)."""
+
+    gas_sponsorship: Optional[bool] = None
+    r"""Optionally request gas sponsorship. If `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`)."""

compass_api_sdk/models/earnswapresponse.py

@@ -0,0 +1,55 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .batchedsafeoperationsresponse_output import (
+    BatchedSafeOperationsResponseOutput,
+    BatchedSafeOperationsResponseOutputTypedDict,
+)
+from .unsignedtransaction import UnsignedTransaction, UnsignedTransactionTypedDict
+from compass_api_sdk.types import BaseModel, Nullable, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing_extensions import TypedDict
+
+
+class EarnSwapResponseTypedDict(TypedDict):
+    transaction: Nullable[UnsignedTransactionTypedDict]
+    eip_712: Nullable[BatchedSafeOperationsResponseOutputTypedDict]
+    estimated_amount_out: str
+
+
+class EarnSwapResponse(BaseModel):
+    transaction: Nullable[UnsignedTransaction]
+
+    eip_712: Nullable[BatchedSafeOperationsResponseOutput]
+
+    estimated_amount_out: str
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = []
+        nullable_fields = ["transaction", "eip_712"]
+        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