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

compass_api_sdk/earn.py

@@ -13,10 +13,7 @@ class Earn(BaseSDK):
         self,
         *,
         chain: models.V2EarnPositionsChain,
-        user_address: str,
-        offset: Optional[int] = None,
-        limit: Optional[int] = None,
-        days: Optional[int] = None,
+        owner: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -24,13 +21,17 @@ class Earn(BaseSDK):
     ) -> models.EarnPositionsResponse:
         r"""List earn positions
 
-        This endpoint fetches all Compass Earn positions.
+        List all Earn positions for a given owner with PnL tracking.
+
+        Returns position data including current balance, cost basis, and profit and loss.
+        Use this endpoint to display portfolio performance, track yields over time, or build
+        position management interfaces.
+
+        Positions are tracked across all venue types (vaults and Aave markets). Each
+        position includes the venue address, deposited amount, and performance metrics.
 
         :param chain:
-        :param user_address: The address of the user to get vault positions for.
-        :param offset: The offset of the first item to return.
-        :param limit: The number of items to return.
-        :param days: How many days back from the current time to include in the blockchain scan.
+        :param owner: The address of the owner of the earn account to get positions for.
         :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
@@ -47,11 +48,8 @@ class Earn(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.V2EarnPositionsRequest(
-            offset=offset,
-            limit=limit,
             chain=chain,
-            user_address=user_address,
-            days=days,
+            owner=owner,
         )
 
         req = self._build_request(
@@ -113,10 +111,7 @@ class Earn(BaseSDK):
         self,
         *,
         chain: models.V2EarnPositionsChain,
-        user_address: str,
-        offset: Optional[int] = None,
-        limit: Optional[int] = None,
-        days: Optional[int] = None,
+        owner: str,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -124,13 +119,17 @@ class Earn(BaseSDK):
     ) -> models.EarnPositionsResponse:
         r"""List earn positions
 
-        This endpoint fetches all Compass Earn positions.
+        List all Earn positions for a given owner with PnL tracking.
+
+        Returns position data including current balance, cost basis, and profit and loss.
+        Use this endpoint to display portfolio performance, track yields over time, or build
+        position management interfaces.
+
+        Positions are tracked across all venue types (vaults and Aave markets). Each
+        position includes the venue address, deposited amount, and performance metrics.
 
         :param chain:
-        :param user_address: The address of the user to get vault positions for.
-        :param offset: The offset of the first item to return.
-        :param limit: The number of items to return.
-        :param days: How many days back from the current time to include in the blockchain scan.
+        :param owner: The address of the owner of the earn account to get positions for.
         :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
@@ -147,11 +146,8 @@ class Earn(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.V2EarnPositionsRequest(
-            offset=offset,
-            limit=limit,
             chain=chain,
-            user_address=user_address,
-            days=days,
+            owner=owner,
         )
 
         req = self._build_request_async(
@@ -213,7 +209,7 @@ class Earn(BaseSDK):
         self,
         *,
         order_by: str,
-        direction: Optional[models.Direction] = None,
+        direction: Optional[models.V2EarnVaultsDirection] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
         chain: OptionalNullable[models.Chain] = UNSET,
@@ -225,9 +221,13 @@ class Earn(BaseSDK):
     ) -> models.VaultsResponse:
         r"""List vaults
 
-        List information about 4626 vaults.
+        List ERC-4626 yield vaults across DeFi venues.
+
+        Returns vault data including APY, TVL, and underlying asset information. Use this endpoint to discover yield opportunities, compare rates across venues, or build vault selection interfaces.
+
+        Supports dozens of vaults and markets like Morpho and other ERC-4626 compatible yield venues.
 
-        These are earn opportunities for protocols like morpho.
+        To deposit into a vault, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=VAULTS`.
 
         :param order_by: The field to order the results by.
         :param direction: The direction to order the results by.
@@ -318,7 +318,7 @@ class Earn(BaseSDK):
         self,
         *,
         order_by: str,
-        direction: Optional[models.Direction] = None,
+        direction: Optional[models.V2EarnVaultsDirection] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
         chain: OptionalNullable[models.Chain] = UNSET,
@@ -330,9 +330,13 @@ class Earn(BaseSDK):
     ) -> models.VaultsResponse:
         r"""List vaults
 
-        List information about 4626 vaults.
+        List ERC-4626 yield vaults across DeFi venues.
 
-        These are earn opportunities for protocols like morpho.
+        Returns vault data including APY, TVL, and underlying asset information. Use this endpoint to discover yield opportunities, compare rates across venues, or build vault selection interfaces.
+
+        Supports dozens of vaults and markets like Morpho and other ERC-4626 compatible yield venues.
+
+        To deposit into a vault, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=VAULTS`.
 
         :param order_by: The field to order the results by.
         :param direction: The direction to order the results by.
@@ -430,16 +434,13 @@ class Earn(BaseSDK):
     ) -> models.ListAaveMarketsResponse:
         r"""List aave markets
 
-        List all aave markets with their supply and borrow rates.
+        List Aave lending markets with supply and borrow rates.
 
-        Returns rates organized by token symbol, with chain-specific data for each token.
-        Each token includes rates for all chains where it's available, plus information
-        about which chain offers the highest supply APY.
+        Returns rates organized by token symbol, with chain-specific data for each token. Each token includes rates for all chains where it's available, plus information about which chain offers the highest supply APY.
 
-        APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with
-        zero APY on both supply and borrow are excluded.
+        APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with zero APY on both supply and borrow are excluded.
 
-        Optionally filter by chain.
+        To deposit into an Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=AAVE`.
 
         :param chain: Optional chain filter. If not provided, returns rates for all chains.
         :param retries: Override the default retry configuration for this method
@@ -527,16 +528,13 @@ class Earn(BaseSDK):
     ) -> models.ListAaveMarketsResponse:
         r"""List aave markets
 
-        List all aave markets with their supply and borrow rates.
+        List Aave lending markets with supply and borrow rates.
 
-        Returns rates organized by token symbol, with chain-specific data for each token.
-        Each token includes rates for all chains where it's available, plus information
-        about which chain offers the highest supply APY.
+        Returns rates organized by token symbol, with chain-specific data for each token. Each token includes rates for all chains where it's available, plus information about which chain offers the highest supply APY.
 
-        APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with
-        zero APY on both supply and borrow are excluded.
+        APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with zero APY on both supply and borrow are excluded.
 
-        Optionally filter by chain.
+        To deposit into an Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=AAVE`.
 
         :param chain: Optional chain filter. If not provided, returns rates for all chains.
         :param retries: Override the default retry configuration for this method
@@ -613,6 +611,230 @@ class Earn(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def earn_pendle_markets(
+        self,
+        *,
+        order_by: str,
+        direction: Optional[models.V2EarnPendleMarketsDirection] = None,
+        offset: Optional[int] = None,
+        limit: Optional[int] = None,
+        chain: OptionalNullable[models.Chain] = UNSET,
+        underlying_symbol: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.PendleMarketsResponse:
+        r"""List pendle markets
+
+        List Pendle yield trading markets with TVL and implied APY.
+
+        Returns Pendle market data including Principal Token (PT), Standardized Yield (SY),
+        and Yield Token (YT) addresses, along with market expiry, TVL, and implied APY.
+
+        Use this endpoint to discover yield trading opportunities, compare rates across
+        Pendle markets, or build market selection interfaces.
+
+        APY values are returned in percentage format (e.g., 5.25 means 5.25%). Markets
+        without complete metadata or statistics are excluded.
+
+        :param order_by: The field to order the results by.
+        :param direction: The direction to order the results by.
+        :param offset: The offset of the first item to return.
+        :param limit: The number of items to return.
+        :param chain: Optional chain filter. If not provided, returns markets for all chains.
+        :param underlying_symbol: Filter markets by underlying asset symbol (e.g., 'USDC', 'WETH').
+        :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
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.V2EarnPendleMarketsRequest(
+            order_by=order_by,
+            direction=direction,
+            offset=offset,
+            limit=limit,
+            chain=chain,
+            underlying_symbol=underlying_symbol,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v2/earn/pendle_markets",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="v2_earn_pendle_markets",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+            ),
+            request=req,
+            error_status_codes=["422", "4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.PendleMarketsResponse, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def earn_pendle_markets_async(
+        self,
+        *,
+        order_by: str,
+        direction: Optional[models.V2EarnPendleMarketsDirection] = None,
+        offset: Optional[int] = None,
+        limit: Optional[int] = None,
+        chain: OptionalNullable[models.Chain] = UNSET,
+        underlying_symbol: OptionalNullable[str] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.PendleMarketsResponse:
+        r"""List pendle markets
+
+        List Pendle yield trading markets with TVL and implied APY.
+
+        Returns Pendle market data including Principal Token (PT), Standardized Yield (SY),
+        and Yield Token (YT) addresses, along with market expiry, TVL, and implied APY.
+
+        Use this endpoint to discover yield trading opportunities, compare rates across
+        Pendle markets, or build market selection interfaces.
+
+        APY values are returned in percentage format (e.g., 5.25 means 5.25%). Markets
+        without complete metadata or statistics are excluded.
+
+        :param order_by: The field to order the results by.
+        :param direction: The direction to order the results by.
+        :param offset: The offset of the first item to return.
+        :param limit: The number of items to return.
+        :param chain: Optional chain filter. If not provided, returns markets for all chains.
+        :param underlying_symbol: Filter markets by underlying asset symbol (e.g., 'USDC', 'WETH').
+        :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
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.V2EarnPendleMarketsRequest(
+            order_by=order_by,
+            direction=direction,
+            offset=offset,
+            limit=limit,
+            chain=chain,
+            underlying_symbol=underlying_symbol,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v2/earn/pendle_markets",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="v2_earn_pendle_markets",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+            ),
+            request=req,
+            error_status_codes=["422", "4XX", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.PendleMarketsResponse, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
     def earn_create_account(
         self,
         *,
@@ -627,17 +849,15 @@ class Earn(BaseSDK):
     ) -> models.CreateAccountResponse:
         r"""Create earn account
 
-        Create an Earn Account.
-
-        Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
+        Create an Earn Account for a wallet address.
 
-        Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
+        Before depositing into venues or managing positions, the owner must create an Earn Account. Each wallet address has one Earn Account per chain.
 
-        1) **No gas-sponsorship:** The `owner` signs a transaction and submits it to the network for execution. The `owner` covers the cost of gas in this case.
+        Returns an unsigned transaction to create the account. The `sender` signs and broadcasts this transaction.
 
-        2) **Gas-sponsorship:** The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Here, another wallet address is set as `sender`. This wallet will sign, submit and cover the gas fees of the transaction.
+        **If owner pays gas:** Set `sender` to the owner's address.
 
-        The creation of an Earn Account itself can be a gas-sponsored transaction by setting the `sender` to the wallet which will sign and send the transaction.
+        **If someone else pays gas:** Set `sender` to the wallet that will sign and broadcast the transaction on behalf of the owner.
 
         :param chain:
         :param sender: The address of the transaction sender.
@@ -737,17 +957,15 @@ class Earn(BaseSDK):
     ) -> models.CreateAccountResponse:
         r"""Create earn account
 
-        Create an Earn Account.
+        Create an Earn Account for a wallet address.
 
-        Before creating Earn positions, the `owner` must create an Earn Account associated with their wallet address.
+        Before depositing into venues or managing positions, the owner must create an Earn Account. Each wallet address has one Earn Account per chain.
 
-        Only the `owner` has the authority to sign transactions for this account. This can be done in one of two ways:
+        Returns an unsigned transaction to create the account. The `sender` signs and broadcasts this transaction.
 
-        1) **No gas-sponsorship:** The `owner` signs a transaction and submits it to the network for execution. The `owner` covers the cost of gas in this case.
+        **If owner pays gas:** Set `sender` to the owner's address.
 
-        2) **Gas-sponsorship:** The `owner` does an off-chain EIP-712 signature and submits this signature to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). Here, another wallet address is set as `sender`. This wallet will sign, submit and cover the gas fees of the transaction.
-
-        The creation of an Earn Account itself can be a gas-sponsored transaction by setting the `sender` to the wallet which will sign and send the transaction.
+        **If someone else pays gas:** Set `sender` to the wallet that will sign and broadcast the transaction on behalf of the owner.
 
         :param chain:
         :param sender: The address of the transaction sender.
@@ -852,14 +1070,23 @@ class Earn(BaseSDK):
     ) -> models.EarnTransferResponse:
         r"""Transfer tokens to/from account
 
-        Transfer tokens to and from an Earn Account.
+        Transfer tokens between an owner's wallet and their Earn Account.
+
+        Use `DEPOSIT` to move tokens from the owner's wallet into their Earn Account. Use `WITHDRAW` to move tokens from the Earn Account back to the owner's wallet.
+
+        **Gas-sponsored deposits** require two steps:
 
-        If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
+        **Step 1 (once per token):** Set up Permit2 allowance
+        1. Call [/gas_sponsorship/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) to get EIP-712 typed data
+        2. Owner signs the typed data
+        3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
 
-        If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
+        **Step 2 (each transfer):** Execute the gas-sponsored transfer
+        1. Call this endpoint with `gas_sponsorship=true` to get EIP-712 typed data
+        2. Owner signs the typed data
+        3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
 
-        If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many `owner`s, this one-time allowance will already have been set for the token they would like to transfer.
-        Once the one-time allowance is set for a given token and `gas_sponsorship` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where a `sender` can be set for the transaction.
+        **Note:** This endpoint moves tokens to/from the Earn Account itself—not into yield venues. To deposit into a vault or Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position).
 
         :param owner: The owner's wallet address.
         :param chain: The chain to use.
@@ -970,14 +1197,23 @@ class Earn(BaseSDK):
     ) -> models.EarnTransferResponse:
         r"""Transfer tokens to/from account
 
-        Transfer tokens to and from an Earn Account.
+        Transfer tokens between an owner's wallet and their Earn Account.
 
-        If `DEPOSIT`'` is selected, tokens will be transferred from the `owner`'s wallet into their Earn Account.
+        Use `DEPOSIT` to move tokens from the owner's wallet into their Earn Account. Use `WITHDRAW` to move tokens from the Earn Account back to the owner's wallet.
 
-        If `WITHDRAW` is selected, tokens will be transferred from the `owner`'s Earn Account into their wallet.
+        **Gas-sponsored deposits** require two steps:
 
-        If a gas-sponsored `DEPOSIT` transfer is desired for a given token, a one-time Permit2 allowance must be set before proceeding. This is common practice for many other applications and, for many `owner`s, this one-time allowance will already have been set for the token they would like to transfer.
-        Once the one-time allowance is set for a given token and `gas_sponsorship` is set to 'true', EIP-712 typed data will be returned and can be signed off-chain by the user. This signature can then be submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`) where a `sender` can be set for the transaction.
+        **Step 1 (once per token):** Set up Permit2 allowance
+        1. Call [/gas_sponsorship/approve_transfer](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/approve-token-transfer) to get EIP-712 typed data
+        2. Owner signs the typed data
+        3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
+
+        **Step 2 (each transfer):** Execute the gas-sponsored transfer
+        1. Call this endpoint with `gas_sponsorship=true` to get EIP-712 typed data
+        2. Owner signs the typed data
+        3. Submit signature + typed data to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction)
+
+        **Note:** This endpoint moves tokens to/from the Earn Account itself—not into yield venues. To deposit into a vault or Aave market, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position).
 
         :param owner: The owner's wallet address.
         :param chain: The chain to use.
@@ -1088,25 +1324,25 @@ class Earn(BaseSDK):
     ) -> models.EarnManageResponse:
         r"""Manage earn position
 
-        Manage an Earn position for a given `owner`'s Earn Account.
-
-        The `owner` is the main wallet address that owns and controls the Earn Account. It is not the Earn Account address itself.
-
-        Venue Types:
-        - VAULTS
-        - AAVE
+        Deposit into or withdraw from a yield venue.
 
-        If `DEPOSIT` is selected for `action`, tokens will be deposited into the selected venue address from the Earn Account associated with the  `owner` wallet.
+        Use `DEPOSIT` to move tokens from the Earn Account into a vault, Aave market, or Pendle PT position. Use `WITHDRAW` to move tokens back from a venue into the Earn Account.
 
-        If `WITHDRAW` is selected for `action`, tokens will be withdrawn from the selected venue address back into the Earn Account associated with the `owner` wallet.
+        **Venue types:**
+        - `VAULT`: ERC-4626 vaults (see [/vaults](https://docs.compasslabs.ai/v2/api-reference/earn/list-vaults) for available options)
+        - `AAVE`: Aave lending pools (see [/aave_markets](https://docs.compasslabs.ai/v2/api-reference/earn/list-aave-markets) for available options)
+        - `PENDLE_PT`: Pendle Principal Tokens (see [/pendle_markets](https://docs.compasslabs.ai/v2/api-reference/earn/list-pendle-markets) for available options)
 
-        A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
+        **Fees:** A fee can be configured and deducted from the transaction amount (not supported for PENDLE_PT):
+        - `FIXED`: A fixed token amount (e.g., 0.1 means 0.1 tokens)
+        - `PERCENTAGE`: A percentage of the amount (e.g., 1.5 means 1.5%)
+        - `PERFORMANCE`: A percentage of realized profit (withdrawals only)
 
-        The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is 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`) where the `sender` of the transaction can be set.
+        **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
 
         :param venue: The earn venue.
         :param action: Whether you are depositing into or withdrawing from the given Earn `venue`.
-        :param amount: 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.
+        :param amount: 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.
         :param owner: The primary wallet address that owns and controls the Earn Account.
         :param chain: The chain to use.
         :param gas_sponsorship: 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`).
@@ -1213,25 +1449,25 @@ class Earn(BaseSDK):
     ) -> models.EarnManageResponse:
         r"""Manage earn position
 
-        Manage an Earn position for a given `owner`'s Earn Account.
+        Deposit into or withdraw from a yield venue.
 
-        The `owner` is the main wallet address that owns and controls the Earn Account. It is not the Earn Account address itself.
+        Use `DEPOSIT` to move tokens from the Earn Account into a vault, Aave market, or Pendle PT position. Use `WITHDRAW` to move tokens back from a venue into the Earn Account.
 
-        Venue Types:
-        - VAULTS
-        - AAVE
+        **Venue types:**
+        - `VAULT`: ERC-4626 vaults (see [/vaults](https://docs.compasslabs.ai/v2/api-reference/earn/list-vaults) for available options)
+        - `AAVE`: Aave lending pools (see [/aave_markets](https://docs.compasslabs.ai/v2/api-reference/earn/list-aave-markets) for available options)
+        - `PENDLE_PT`: Pendle Principal Tokens (see [/pendle_markets](https://docs.compasslabs.ai/v2/api-reference/earn/list-pendle-markets) for available options)
 
-        If `DEPOSIT` is selected for `action`, tokens will be deposited into the selected venue address from the Earn Account associated with the  `owner` wallet.
+        **Fees:** A fee can be configured and deducted from the transaction amount (not supported for PENDLE_PT):
+        - `FIXED`: A fixed token amount (e.g., 0.1 means 0.1 tokens)
+        - `PERCENTAGE`: A percentage of the amount (e.g., 1.5 means 1.5%)
+        - `PERFORMANCE`: A percentage of realized profit (withdrawals only)
 
-        If `WITHDRAW` is selected for `action`, tokens will be withdrawn from the selected venue address back into the Earn Account associated with the `owner` wallet.
-
-        A fee can be configured. This fee is deducted from the total `amount`. It can be expressed as a `FIXED` amount or a `PERCENTAGE` of `amount`.
-
-        The transaction can be gas-sponsored by an arbitrary wallet address which will sign, submit and pay the required gas for the transaction. If `gas_sponsorship` is 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`) where the `sender` of the transaction can be set.
+        **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
 
         :param venue: The earn venue.
         :param action: Whether you are depositing into or withdrawing from the given Earn `venue`.
-        :param amount: 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.
+        :param amount: 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.
         :param owner: The primary wallet address that owns and controls the Earn Account.
         :param chain: The chain to use.
         :param gas_sponsorship: 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`).
@@ -1344,6 +1580,12 @@ class Earn(BaseSDK):
 
         Swap tokens within an Earn Account.
 
+        Use this endpoint to exchange one token for another without transferring funds out of the Earn Account.
+
+        The swap executes atomically within the Earn Account and can be combined with other actions using the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions). For example, swap ETH to USDC, then deposit USDC into a vault—all in one transaction.
+
+        Returns either an unsigned transaction (when `gas_sponsorship=false`) or EIP-712 typed data for off-chain signing (when `gas_sponsorship=true`). For gas-sponsored swaps, submit the signed typed data to `/gas_sponsorship/prepare`.
+
         :param token_in: Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address.
         :param token_out: Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address.
         :param amount_in: Human-readable amount of `token_in` to swap (token units, not wei).
@@ -1459,6 +1701,12 @@ class Earn(BaseSDK):
 
         Swap tokens within an Earn Account.
 
+        Use this endpoint to exchange one token for another without transferring funds out of the Earn Account.
+
+        The swap executes atomically within the Earn Account and can be combined with other actions using the [bundle endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/execute-multiple-earn-actions). For example, swap ETH to USDC, then deposit USDC into a vault—all in one transaction.
+
+        Returns either an unsigned transaction (when `gas_sponsorship=false`) or EIP-712 typed data for off-chain signing (when `gas_sponsorship=true`). For gas-sponsored swaps, submit the signed typed data to `/gas_sponsorship/prepare`.
+
         :param token_in: Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address.
         :param token_out: Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address.
         :param amount_in: Human-readable amount of `token_in` to swap (token units, not wei).
@@ -1565,20 +1813,19 @@ class Earn(BaseSDK):
     ) -> models.V2BundleResponse:
         r"""Execute multiple earn actions
 
-        This endpoint allows combining multiple actions (swaps, vault
-        deposits/withdrawals, Aave deposits/withdrawals) into a single atomic transaction
-        executed via the Earn account).
+        Combine multiple actions into a single atomic transaction.
+
+        Bundle swaps and venue deposits/withdrawals into one transaction executed through the Earn Account. This saves gas compared to executing actions separately and ensures all actions succeed or fail together.
 
-        **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
+        **Example:** Swap AUSD to USDC, then deposit USDC into a vault - all in one transaction.
 
-        Actions are executed in the order they are provided. Each action type has its own parameters:
+        **Action types:**
+        - `V2_SWAP`: Swap tokens within the Earn Account
+        - `V2_MANAGE`: Deposit/withdraw to ERC-4626 vaults or Aave markets
 
-        - **V2_SWAP**: Swapping tokens within the Earn Account
-        - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
+        Actions execute in the order provided.
 
-        The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
-        This returns EIP-712 typed data that the owner must sign and submit to
-        `/gas_sponsorship/prepare` for execution by a gas sponsor.
+        **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
 
         :param owner: The owner's wallet address that controls the Earn Account.
         :param chain: The chain to use.
@@ -1680,20 +1927,19 @@ class Earn(BaseSDK):
     ) -> models.V2BundleResponse:
         r"""Execute multiple earn actions
 
-        This endpoint allows combining multiple actions (swaps, vault
-        deposits/withdrawals, Aave deposits/withdrawals) into a single atomic transaction
-        executed via the Earn account).
+        Combine multiple actions into a single atomic transaction.
+
+        Bundle swaps and venue deposits/withdrawals into one transaction executed through the Earn Account. This saves gas compared to executing actions separately and ensures all actions succeed or fail together.
 
-        **Example Use Case:** Swap USDC to AUSD, then deposit AUSD into a vault - all in one transaction.
+        **Example:** Swap AUSD to USDC, then deposit USDC into a vault - all in one transaction.
 
-        Actions are executed in the order they are provided. Each action type has its own parameters:
+        **Action types:**
+        - `V2_SWAP`: Swap tokens within the Earn Account
+        - `V2_MANAGE`: Deposit/withdraw to ERC-4626 vaults or Aave markets
 
-        - **V2_SWAP**: Swapping tokens within the Earn Account
-        - **V2_MANAGE**: Manage positions - deposit/withdraw to ERC-4626 vaults or Aave lending pool
+        Actions execute in the order provided.
 
-        The bundled transaction can be gas-sponsored by setting `gas_sponsorship=true`.
-        This returns EIP-712 typed data that the owner must sign and submit to
-        `/gas_sponsorship/prepare` for execution by a gas sponsor.
+        **Gas sponsorship:** Set `gas_sponsorship=true` to receive EIP-712 typed data. Owner signs the typed data, then submit to [/gas_sponsorship/prepare](https://docs.compasslabs.ai/v2/api-reference/gas-sponsorship/prepare-gas-sponsored-transaction).
 
         :param owner: The owner's wallet address that controls the Earn Account.
         :param chain: The chain to use.