compass_api_sdk 2.0.21rc1__py3-none-any.whl → 2.2.1rc3__py3-none-any.whl

compass_api_sdk/models/compass_api_backend_v2_models_earn_read_response_positions_vaultposition.py

@@ -1,49 +1,103 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from compass_api_sdk.types import BaseModel
+from .depositevent import DepositEvent, DepositEventTypedDict
+from .positionpnl import PositionPnL, PositionPnLTypedDict
+from .withdrawalevent import WithdrawalEvent, WithdrawalEventTypedDict
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
 from compass_api_sdk.utils import validate_const
 import pydantic
+from pydantic import model_serializer
 from pydantic.functional_validators import AfterValidator
-from typing import Literal
-from typing_extensions import Annotated, TypedDict
+from typing import List, Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
 
 
 class CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPositionTypedDict(
     TypedDict
 ):
-    id: str
-    r"""Base64-encoded position identifier."""
+    r"""ERC-4626 vault position."""
+
     vault_address: str
-    r"""The vault address you are depositing to."""
-    amount_in_underlying_token: str
-    r"""The user's position value denominated in the underlying token."""
-    token_name: str
-    r"""Symbol of the underlying token (e.g., USDC)."""
+    r"""The vault address."""
     vault_name: str
     r"""Name of the vault token (share token)."""
+    underlying_symbol: str
+    r"""Symbol of the underlying token (e.g., USDC)."""
+    balance: str
+    r"""The user's position value in underlying token."""
     type: Literal["VAULT"]
     r"""The market type discriminator."""
+    pnl: NotRequired[Nullable[PositionPnLTypedDict]]
+    r"""PnL metrics for this position."""
+    deposits: NotRequired[List[DepositEventTypedDict]]
+    r"""All deposit events for this position."""
+    withdrawals: NotRequired[List[WithdrawalEventTypedDict]]
+    r"""All withdrawal events for this position."""
 
 
 class CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPosition(BaseModel):
-    id: str
-    r"""Base64-encoded position identifier."""
+    r"""ERC-4626 vault position."""
 
     vault_address: str
-    r"""The vault address you are depositing to."""
+    r"""The vault address."""
 
-    amount_in_underlying_token: str
-    r"""The user's position value denominated in the underlying token."""
+    vault_name: str
+    r"""Name of the vault token (share token)."""
 
-    token_name: str
+    underlying_symbol: str
     r"""Symbol of the underlying token (e.g., USDC)."""
 
-    vault_name: str
-    r"""Name of the vault token (share token)."""
+    balance: str
+    r"""The user's position value in underlying token."""
 
     TYPE: Annotated[
         Annotated[Literal["VAULT"], AfterValidator(validate_const("VAULT"))],
         pydantic.Field(alias="type"),
     ] = "VAULT"
     r"""The market type discriminator."""
+
+    pnl: OptionalNullable[PositionPnL] = UNSET
+    r"""PnL metrics for this position."""
+
+    deposits: Optional[List[DepositEvent]] = None
+    r"""All deposit events for this position."""
+
+    withdrawals: Optional[List[WithdrawalEvent]] = None
+    r"""All withdrawal events for this position."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["pnl", "deposits", "withdrawals"]
+        nullable_fields = ["pnl"]
+        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/compass_api_backend_v2_models_safe_transact_response_batched_safe_operations_eip712domain.py

@@ -9,21 +9,21 @@ from typing_extensions import Annotated, TypedDict
 class CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712DomainTypedDict(
     TypedDict
 ):
-    r"""The EIP-712 domain separator for Safe transactions."""
+    r"""The EIP-712 domain separator."""
 
     chain_id: int
-    r"""Chain ID for the Safe transaction"""
+    r"""Chain ID"""
     verifying_contract: str
-    r"""Address of the Safe contract"""
+    r"""Address of the Product Account"""
 
 
 class CompassAPIBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain(
     BaseModel
 ):
-    r"""The EIP-712 domain separator for Safe transactions."""
+    r"""The EIP-712 domain separator."""
 
     chain_id: Annotated[int, pydantic.Field(alias="chainId")]
-    r"""Chain ID for the Safe transaction"""
+    r"""Chain ID"""
 
     verifying_contract: Annotated[str, pydantic.Field(alias="verifyingContract")]
-    r"""Address of the Safe contract"""
+    r"""Address of the Product Account"""

compass_api_sdk/models/depositevent.py

@@ -0,0 +1,61 @@
+"""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 DepositEventTypedDict(TypedDict):
+    r"""Historical deposit event for position transparency.
+
+    Uses generic input/output format that works across all protocols:
+    - Vault: input=underlying, output=shares
+    - Aave: input=underlying, output=aTokens
+    - Pendle: input=token (varies), output=PT
+    """
+
+    block_number: int
+    r"""Block number when deposit occurred"""
+    transaction_hash: str
+    r"""Transaction hash of the deposit"""
+    input_amount: str
+    r"""Amount deposited (underlying asset or swap token)"""
+    input_symbol: str
+    r"""Symbol of token deposited"""
+    output_amount: str
+    r"""Units received (shares, aTokens, or PT)"""
+    output_symbol: str
+    r"""Symbol of units received"""
+    cost_per_unit: str
+    r"""Cost basis per unit at time of deposit"""
+
+
+class DepositEvent(BaseModel):
+    r"""Historical deposit event for position transparency.
+
+    Uses generic input/output format that works across all protocols:
+    - Vault: input=underlying, output=shares
+    - Aave: input=underlying, output=aTokens
+    - Pendle: input=token (varies), output=PT
+    """
+
+    block_number: int
+    r"""Block number when deposit occurred"""
+
+    transaction_hash: str
+    r"""Transaction hash of the deposit"""
+
+    input_amount: str
+    r"""Amount deposited (underlying asset or swap token)"""
+
+    input_symbol: str
+    r"""Symbol of token deposited"""
+
+    output_amount: str
+    r"""Units received (shares, aTokens, or PT)"""
+
+    output_symbol: str
+    r"""Symbol of units received"""
+
+    cost_per_unit: str
+    r"""Cost basis per unit at time of deposit"""

compass_api_sdk/models/earnmanageparams.py

@@ -2,6 +2,7 @@
 
 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
@@ -14,13 +15,14 @@ from typing_extensions import Annotated, TypeAliasType, TypedDict
 
 
 EarnManageParamsVenueTypedDict = TypeAliasType(
-    "EarnManageParamsVenueTypedDict", Union[VaultVenueTypedDict, AaveVenueTypedDict]
+    "EarnManageParamsVenueTypedDict",
+    Union[VaultVenueTypedDict, AaveVenueTypedDict, PendlePTVenueTypedDict],
 )
 r"""The earn venue."""
 
 
 EarnManageParamsVenue = Annotated[
-    Union[AaveVenue, VaultVenue], Field(discriminator="TYPE")
+    Union[AaveVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
 ]
 r"""The earn venue."""
 
@@ -33,7 +35,7 @@ class EarnManageParamsAction(str, Enum):
 
 
 class EarnManageParamsTypedDict(TypedDict):
-    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave).
+    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.
@@ -44,13 +46,13 @@ class EarnManageParamsTypedDict(TypedDict):
     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. Provide as a decimal in token units (not wei); must be > 0."""
+    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).
+    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.
@@ -63,7 +65,7 @@ class EarnManageParams(BaseModel):
     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. Provide as a decimal in token units (not wei); must be > 0."""
+    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[

compass_api_sdk/models/earnmanagerequest.py

@@ -4,6 +4,7 @@ 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,
@@ -22,13 +23,14 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 
 EarnManageRequestVenueTypedDict = TypeAliasType(
-    "EarnManageRequestVenueTypedDict", Union[VaultVenueTypedDict, AaveVenueTypedDict]
+    "EarnManageRequestVenueTypedDict",
+    Union[VaultVenueTypedDict, AaveVenueTypedDict, PendlePTVenueTypedDict],
 )
 r"""The earn venue."""
 
 
 EarnManageRequestVenue = Annotated[
-    Union[AaveVenue, VaultVenue], Field(discriminator="TYPE")
+    Union[AaveVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
 ]
 r"""The earn venue."""
 
@@ -51,7 +53,7 @@ class EarnManageRequestTypedDict(TypedDict):
     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. Provide as a decimal in token units (not wei); must be > 0."""
+    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
@@ -77,7 +79,7 @@ class EarnManageRequest(BaseModel):
     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. Provide as a decimal in token units (not wei); must be > 0."""
+    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."""

compass_api_sdk/models/earnpositionsresponse.py

@@ -6,34 +6,43 @@ from .compass_api_backend_v2_models_earn_read_response_positions_vaultposition i
     CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPosition,
     CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPositionTypedDict,
 )
+from .pendleptposition import PendlePTPosition, PendlePTPositionTypedDict
 from compass_api_sdk.types import BaseModel
-from pydantic import Field
-from typing import List, Union
-from typing_extensions import Annotated, TypeAliasType, TypedDict
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
 
 
-UserPositionTypedDict = TypeAliasType(
-    "UserPositionTypedDict",
-    Union[
-        CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPositionTypedDict,
-        AavePositionTypedDict,
-    ],
-)
+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.
+    """
 
-UserPosition = Annotated[
-    Union[
-        AavePosition, CompassAPIBackendV2ModelsEarnReadResponsePositionsVaultPosition
-    ],
-    Field(discriminator="TYPE"),
-]
+    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 EarnPositionsResponseTypedDict(TypedDict):
-    user_positions: List[UserPositionTypedDict]
-    r"""A list of the user's earn 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.
+    """
 
-class EarnPositionsResponse(BaseModel):
-    user_positions: List[UserPosition]
-    r"""A list of the user's earn positions."""
+    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/fee.py

@@ -8,27 +8,28 @@ from typing_extensions import NotRequired, TypeAliasType, TypedDict
 
 
 FeeAmountTypedDict = TypeAliasType("FeeAmountTypedDict", Union[float, str])
-r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens)."""
+r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
 
 
 FeeAmount = TypeAliasType("FeeAmount", Union[float, str])
-r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens)."""
+r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
 
 
 class Denomination(str, Enum):
-    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens)."""
+    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit)."""
 
     PERCENTAGE = "PERCENTAGE"
     FIXED = "FIXED"
+    PERFORMANCE = "PERFORMANCE"
 
 
 class FeeTypedDict(TypedDict):
     recipient: str
     r"""The wallet address that will receive the fee."""
     amount: FeeAmountTypedDict
-    r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens)."""
+    r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
     denomination: NotRequired[Denomination]
-    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens)."""
+    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit)."""
 
 
 class Fee(BaseModel):
@@ -36,7 +37,7 @@ class Fee(BaseModel):
     r"""The wallet address that will receive the fee."""
 
     amount: FeeAmount
-    r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens)."""
+    r"""The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit)."""
 
     denomination: Optional[Denomination] = None
-    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens)."""
+    r"""The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount), 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens), or 'PERFORMANCE' for a fee based on realized profit using FIFO cost basis (e.g., 10 means 10% of profit)."""

compass_api_sdk/models/pendledepositevent.py

@@ -0,0 +1,49 @@
+"""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 PendleDepositEventTypedDict(TypedDict):
+    r"""Pendle PT deposit event with cost basis at time of deposit."""
+
+    block_number: int
+    r"""Block number when deposit occurred"""
+    transaction_hash: str
+    r"""Transaction hash of the deposit"""
+    input_amount: str
+    r"""Amount deposited (token spent)"""
+    input_symbol: str
+    r"""Symbol of token deposited"""
+    output_amount: str
+    r"""PT tokens received"""
+    output_symbol: str
+    r"""Symbol (PT)"""
+    cost_per_unit: str
+    r"""Cost basis per PT at deposit (SY spent per PT acquired)"""
+
+
+class PendleDepositEvent(BaseModel):
+    r"""Pendle PT deposit event with cost basis at time of deposit."""
+
+    block_number: int
+    r"""Block number when deposit occurred"""
+
+    transaction_hash: str
+    r"""Transaction hash of the deposit"""
+
+    input_amount: str
+    r"""Amount deposited (token spent)"""
+
+    input_symbol: str
+    r"""Symbol of token deposited"""
+
+    output_amount: str
+    r"""PT tokens received"""
+
+    output_symbol: str
+    r"""Symbol (PT)"""
+
+    cost_per_unit: str
+    r"""Cost basis per PT at deposit (SY spent per PT acquired)"""

compass_api_sdk/models/pendlemarketinfo.py

@@ -0,0 +1,138 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing_extensions import NotRequired, TypedDict
+
+
+class PendleMarketInfoTypedDict(TypedDict):
+    r"""Information about a single Pendle market from the database."""
+
+    market_address: str
+    r"""The Pendle market contract address."""
+    chain: str
+    r"""Blockchain name (e.g., 'ethereum', 'arbitrum')."""
+    pt_address: str
+    r"""The Principal Token (PT) address."""
+    sy_address: NotRequired[Nullable[str]]
+    r"""The Standardized Yield (SY) token address."""
+    yt_address: NotRequired[Nullable[str]]
+    r"""The Yield Token (YT) address."""
+    expiry: NotRequired[Nullable[int]]
+    r"""The market maturity timestamp (Unix epoch seconds)."""
+    underlying_asset: NotRequired[Nullable[str]]
+    r"""The underlying asset contract address."""
+    underlying_name: NotRequired[Nullable[str]]
+    r"""The name of the underlying asset."""
+    underlying_symbol: NotRequired[Nullable[str]]
+    r"""The symbol of the underlying asset (e.g., 'USDC')."""
+    pt_name: NotRequired[Nullable[str]]
+    r"""The name of the Principal Token."""
+    pt_symbol: NotRequired[Nullable[str]]
+    r"""The symbol of the Principal Token."""
+    tvl_usd: NotRequired[Nullable[str]]
+    r"""Total Value Locked in USD."""
+    implied_apy: NotRequired[Nullable[str]]
+    r"""Implied APY as a percentage (e.g., 5.25 = 5.25%)."""
+
+
+class PendleMarketInfo(BaseModel):
+    r"""Information about a single Pendle market from the database."""
+
+    market_address: str
+    r"""The Pendle market contract address."""
+
+    chain: str
+    r"""Blockchain name (e.g., 'ethereum', 'arbitrum')."""
+
+    pt_address: str
+    r"""The Principal Token (PT) address."""
+
+    sy_address: OptionalNullable[str] = UNSET
+    r"""The Standardized Yield (SY) token address."""
+
+    yt_address: OptionalNullable[str] = UNSET
+    r"""The Yield Token (YT) address."""
+
+    expiry: OptionalNullable[int] = UNSET
+    r"""The market maturity timestamp (Unix epoch seconds)."""
+
+    underlying_asset: OptionalNullable[str] = UNSET
+    r"""The underlying asset contract address."""
+
+    underlying_name: OptionalNullable[str] = UNSET
+    r"""The name of the underlying asset."""
+
+    underlying_symbol: OptionalNullable[str] = UNSET
+    r"""The symbol of the underlying asset (e.g., 'USDC')."""
+
+    pt_name: OptionalNullable[str] = UNSET
+    r"""The name of the Principal Token."""
+
+    pt_symbol: OptionalNullable[str] = UNSET
+    r"""The symbol of the Principal Token."""
+
+    tvl_usd: OptionalNullable[str] = UNSET
+    r"""Total Value Locked in USD."""
+
+    implied_apy: OptionalNullable[str] = UNSET
+    r"""Implied APY as a percentage (e.g., 5.25 = 5.25%)."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "sy_address",
+            "yt_address",
+            "expiry",
+            "underlying_asset",
+            "underlying_name",
+            "underlying_symbol",
+            "pt_name",
+            "pt_symbol",
+            "tvl_usd",
+            "implied_apy",
+        ]
+        nullable_fields = [
+            "sy_address",
+            "yt_address",
+            "expiry",
+            "underlying_asset",
+            "underlying_name",
+            "underlying_symbol",
+            "pt_name",
+            "pt_symbol",
+            "tvl_usd",
+            "implied_apy",
+        ]
+        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/pendlemarketsresponse.py

@@ -0,0 +1,30 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .pendlemarketinfo import PendleMarketInfo, PendleMarketInfoTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class PendleMarketsResponseTypedDict(TypedDict):
+    r"""Response model for a paginated list of Pendle markets."""
+
+    total: int
+    offset: int
+    limit: int
+    markets: List[PendleMarketInfoTypedDict]
+    r"""A list of Pendle market information objects."""
+
+
+class PendleMarketsResponse(BaseModel):
+    r"""Response model for a paginated list of Pendle markets."""
+
+    total: int
+
+    offset: int
+
+    limit: int
+
+    markets: List[PendleMarketInfo]
+    r"""A list of Pendle market information objects."""