compass_api_sdk 2.2.118__tar.gz → 2.2.119__tar.gz

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.118
+Version: 2.2.119
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10
@@ -261,6 +261,7 @@ with CompassAPI(
 * [earn_vaults](docs/sdks/earn/README.md#earn_vaults) - List vaults
 * [earn_aave_markets](docs/sdks/earn/README.md#earn_aave_markets) - List aave markets
 * [earn_pendle_markets](docs/sdks/earn/README.md#earn_pendle_markets) - List pendle markets
+* [earn_maple_pools](docs/sdks/earn/README.md#earn_maple_pools) - List maple pools
 * [earn_swap_quote](docs/sdks/earn/README.md#earn_swap_quote) - Quote a swap
 * [earn_balances](docs/sdks/earn/README.md#earn_balances) - Get token balances
 * [earn_create_account](docs/sdks/earn/README.md#earn_create_account) - Create earn account
@@ -509,8 +510,8 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 140 methods.*
-* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 140 methods.*
+* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 141 methods.*
+* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 141 methods.*
 * [`ResponseValidationError`](./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/README-PYPI.md

@@ -242,6 +242,7 @@ with CompassAPI(
 * [earn_vaults](docs/sdks/earn/README.md#earn_vaults) - List vaults
 * [earn_aave_markets](docs/sdks/earn/README.md#earn_aave_markets) - List aave markets
 * [earn_pendle_markets](docs/sdks/earn/README.md#earn_pendle_markets) - List pendle markets
+* [earn_maple_pools](docs/sdks/earn/README.md#earn_maple_pools) - List maple pools
 * [earn_swap_quote](docs/sdks/earn/README.md#earn_swap_quote) - Quote a swap
 * [earn_balances](docs/sdks/earn/README.md#earn_balances) - Get token balances
 * [earn_create_account](docs/sdks/earn/README.md#earn_create_account) - Create earn account
@@ -490,8 +491,8 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 140 methods.*
-* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 140 methods.*
+* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 141 methods.*
+* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 141 methods.*
 * [`ResponseValidationError`](./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.118"
+version = "2.2.119"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -14,7 +14,7 @@ dependencies = [
 
 [tool.poetry]
 name = "compass_api_sdk"
-version = "2.2.118"
+version = "2.2.119"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/src/compass_api_sdk/earn.py

@@ -1097,6 +1097,206 @@ class Earn(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def earn_maple_pools(
+        self,
+        *,
+        chain: models.V2EarnMaplePoolsChain,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.MaplePoolsResponse:
+        r"""List maple pools
+
+        List the Maple syrup pools (syrupUSDC, syrupUSDT) available through the
+        `MAPLE` venue, with exchange rate, TVL, 7-day APY and withdrawal-queue state.
+
+        Deposit with the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)
+        using `{\"type\": \"MAPLE\", \"pool_address\": ...}`: shares are minted directly from
+        Maple at the pool exchange rate, and the Earn Account is authorized with Maple
+        automatically on its first deposit. Withdrawals are asynchronous (Maple's
+        withdrawal queue, typically minutes, at most 30 days); to exit immediately at
+        market price, use the [swap endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/swap-tokens).
+
+        Maple pools are on Ethereum; other chains return an empty list.
+
+        :param chain: Blockchain network. Maple syrup pools are on Ethereum; other chains return an empty list.
+        :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.V2EarnMaplePoolsRequest(
+            chain=chain,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v2/earn/maple_pools",
+            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_maple_pools",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+                tags=["Earn"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.MaplePoolsResponse, 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_maple_pools_async(
+        self,
+        *,
+        chain: models.V2EarnMaplePoolsChain,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.MaplePoolsResponse:
+        r"""List maple pools
+
+        List the Maple syrup pools (syrupUSDC, syrupUSDT) available through the
+        `MAPLE` venue, with exchange rate, TVL, 7-day APY and withdrawal-queue state.
+
+        Deposit with the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)
+        using `{\"type\": \"MAPLE\", \"pool_address\": ...}`: shares are minted directly from
+        Maple at the pool exchange rate, and the Earn Account is authorized with Maple
+        automatically on its first deposit. Withdrawals are asynchronous (Maple's
+        withdrawal queue, typically minutes, at most 30 days); to exit immediately at
+        market price, use the [swap endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/swap-tokens).
+
+        Maple pools are on Ethereum; other chains return an empty list.
+
+        :param chain: Blockchain network. Maple syrup pools are on Ethereum; other chains return an empty list.
+        :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.V2EarnMaplePoolsRequest(
+            chain=chain,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v2/earn/maple_pools",
+            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_maple_pools",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+                tags=["Earn"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.MaplePoolsResponse, 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_swap_quote(
         self,
         *,
@@ -2048,12 +2248,13 @@ class Earn(BaseSDK):
 
         Deposit into or withdraw from a yield venue.
 
-        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.
+        Use `DEPOSIT` to move tokens from the Earn Account into a vault, Aave market, Pendle PT position, or Maple syrup pool. Use `WITHDRAW` to move tokens back from a venue into the Earn Account.
 
         **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)
+        - `MAPLE`: Maple syrup pools on Ethereum, syrupUSDC and syrupUSDT (see [/maple_pools](https://docs.compasslabs.ai/v2/api-reference/earn/list-maple-pools)). Deposits mint shares directly from Maple at the pool exchange rate; the Earn Account is authorized with Maple automatically on its first deposit. Withdrawals are **asynchronous**: the response has `settlement: \"async\"`, and the asset arrives in the Earn Account when Maple processes its withdrawal queue (typically within minutes, at most 30 days). Fees are not supported on MAPLE withdrawals. To exit immediately at market price, use [/swap](https://docs.compasslabs.ai/v2/api-reference/earn/swap-tokens).
 
         **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)
@@ -2064,7 +2265,7 @@ class Earn(BaseSDK):
 
         :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; 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 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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). 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: Blockchain network
         :param fee: 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, as a fixed token amount, or as a percentage of realized profit (PERFORMANCE).
@@ -2177,12 +2378,13 @@ class Earn(BaseSDK):
 
         Deposit into or withdraw from a yield venue.
 
-        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.
+        Use `DEPOSIT` to move tokens from the Earn Account into a vault, Aave market, Pendle PT position, or Maple syrup pool. Use `WITHDRAW` to move tokens back from a venue into the Earn Account.
 
         **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)
+        - `MAPLE`: Maple syrup pools on Ethereum, syrupUSDC and syrupUSDT (see [/maple_pools](https://docs.compasslabs.ai/v2/api-reference/earn/list-maple-pools)). Deposits mint shares directly from Maple at the pool exchange rate; the Earn Account is authorized with Maple automatically on its first deposit. Withdrawals are **asynchronous**: the response has `settlement: \"async\"`, and the asset arrives in the Earn Account when Maple processes its withdrawal queue (typically within minutes, at most 30 days). Fees are not supported on MAPLE withdrawals. To exit immediately at market price, use [/swap](https://docs.compasslabs.ai/v2/api-reference/earn/swap-tokens).
 
         **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)
@@ -2193,7 +2395,7 @@ class Earn(BaseSDK):
 
         :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; 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 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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). 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: Blockchain network
         :param fee: 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, as a fixed token amount, or as a percentage of realized profit (PERFORMANCE).

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/src/compass_api_sdk/models/__init__.py

@@ -635,7 +635,11 @@ if TYPE_CHECKING:
         EarnManageRequestVenue,
         EarnManageRequestVenueTypedDict,
     )
-    from .earnmanageresponse import EarnManageResponse, EarnManageResponseTypedDict
+    from .earnmanageresponse import (
+        EarnManageResponse,
+        EarnManageResponseSettlement,
+        EarnManageResponseTypedDict,
+    )
     from .earnpositionsallresponse import (
         EarnPositionsAllResponse,
         EarnPositionsAllResponseTypedDict,
@@ -786,6 +790,18 @@ if TYPE_CHECKING:
     )
     from .looplegpreview import LoopLegPreview, LoopLegPreviewTypedDict
     from .lpbalance import LpBalance, LpBalanceTypedDict
+    from .maplependingredemption import (
+        MaplePendingRedemption,
+        MaplePendingRedemptionTypedDict,
+    )
+    from .maplepoolinfo import MaplePoolInfo, MaplePoolInfoTypedDict
+    from .maplepoolsresponse import MaplePoolsResponse, MaplePoolsResponseTypedDict
+    from .mapleposition import MaplePosition, MaplePositionTypedDict
+    from .maplevenue import MapleVenue, MapleVenueTypedDict
+    from .maplewithdrawalqueue import (
+        MapleWithdrawalQueue,
+        MapleWithdrawalQueueTypedDict,
+    )
     from .marketallocation import MarketAllocation, MarketAllocationTypedDict
     from .marketdetail import MarketDetail, MarketDetailTypedDict
     from .marketposition import MarketPosition, MarketPositionTypedDict
@@ -1393,8 +1409,8 @@ if TYPE_CHECKING:
         TokenizedAssetsTradeRequestTypedDict,
     )
     from .tokenizedassetstraderesponse import (
-        Settlement,
         TokenizedAssetsTradeResponse,
+        TokenizedAssetsTradeResponseSettlement,
         TokenizedAssetsTradeResponseTypedDict,
     )
     from .tokenizedassetstransferrequest import (
@@ -1833,6 +1849,11 @@ if TYPE_CHECKING:
         V2EarnBalancesRequest,
         V2EarnBalancesRequestTypedDict,
     )
+    from .v2_earn_maple_poolsop import (
+        V2EarnMaplePoolsChain,
+        V2EarnMaplePoolsRequest,
+        V2EarnMaplePoolsRequestTypedDict,
+    )
     from .v2_earn_pendle_marketsop import (
         V2EarnPendleMarketsDirection,
         V2EarnPendleMarketsMinTvlUsd,
@@ -1931,6 +1952,7 @@ if TYPE_CHECKING:
     )
     from .v2bundleresponse import (
         V2BundleResponse,
+        V2BundleResponseSettlement,
         V2BundleResponseSwapProvider,
         V2BundleResponseTypedDict,
     )
@@ -2437,6 +2459,7 @@ __all__ = [
     "EarnManageRequestVenue",
     "EarnManageRequestVenueTypedDict",
     "EarnManageResponse",
+    "EarnManageResponseSettlement",
     "EarnManageResponseTypedDict",
     "EarnPositionsAllResponse",
     "EarnPositionsAllResponseTypedDict",
@@ -2553,6 +2576,18 @@ __all__ = [
     "LoopedPositionTypedDict",
     "LpBalance",
     "LpBalanceTypedDict",
+    "MaplePendingRedemption",
+    "MaplePendingRedemptionTypedDict",
+    "MaplePoolInfo",
+    "MaplePoolInfoTypedDict",
+    "MaplePoolsResponse",
+    "MaplePoolsResponseTypedDict",
+    "MaplePosition",
+    "MaplePositionTypedDict",
+    "MapleVenue",
+    "MapleVenueTypedDict",
+    "MapleWithdrawalQueue",
+    "MapleWithdrawalQueueTypedDict",
     "MarketAllocation",
     "MarketAllocationTypedDict",
     "MarketDetail",
@@ -2894,7 +2929,6 @@ __all__ = [
     "SetAllowanceRequestContractUnion",
     "SetAllowanceRequestContractUnionTypedDict",
     "SetAllowanceRequestTypedDict",
-    "Settlement",
     "SignedAuthorization",
     "SignedAuthorizationTypedDict",
     "SkyBuyParams",
@@ -3025,6 +3059,7 @@ __all__ = [
     "TokenizedAssetsTradeRequestSlippageTypedDict",
     "TokenizedAssetsTradeRequestTypedDict",
     "TokenizedAssetsTradeResponse",
+    "TokenizedAssetsTradeResponseSettlement",
     "TokenizedAssetsTradeResponseTypedDict",
     "TokenizedAssetsTransferRequest",
     "TokenizedAssetsTransferRequestAction",
@@ -3282,6 +3317,7 @@ __all__ = [
     "V2BundleRequestChain",
     "V2BundleRequestTypedDict",
     "V2BundleResponse",
+    "V2BundleResponseSettlement",
     "V2BundleResponseSwapProvider",
     "V2BundleResponseTypedDict",
     "V2CctpMintResponse",
@@ -3307,6 +3343,9 @@ __all__ = [
     "V2EarnBalancesChain",
     "V2EarnBalancesRequest",
     "V2EarnBalancesRequestTypedDict",
+    "V2EarnMaplePoolsChain",
+    "V2EarnMaplePoolsRequest",
+    "V2EarnMaplePoolsRequestTypedDict",
     "V2EarnPendleMarketsDirection",
     "V2EarnPendleMarketsMinTvlUsd",
     "V2EarnPendleMarketsMinTvlUsdTypedDict",
@@ -3852,6 +3891,7 @@ _dynamic_imports: dict[str, str] = {
     "EarnManageRequestVenue": ".earnmanagerequest",
     "EarnManageRequestVenueTypedDict": ".earnmanagerequest",
     "EarnManageResponse": ".earnmanageresponse",
+    "EarnManageResponseSettlement": ".earnmanageresponse",
     "EarnManageResponseTypedDict": ".earnmanageresponse",
     "EarnPositionsAllResponse": ".earnpositionsallresponse",
     "EarnPositionsAllResponseTypedDict": ".earnpositionsallresponse",
@@ -3967,6 +4007,18 @@ _dynamic_imports: dict[str, str] = {
     "LoopLegPreviewTypedDict": ".looplegpreview",
     "LpBalance": ".lpbalance",
     "LpBalanceTypedDict": ".lpbalance",
+    "MaplePendingRedemption": ".maplependingredemption",
+    "MaplePendingRedemptionTypedDict": ".maplependingredemption",
+    "MaplePoolInfo": ".maplepoolinfo",
+    "MaplePoolInfoTypedDict": ".maplepoolinfo",
+    "MaplePoolsResponse": ".maplepoolsresponse",
+    "MaplePoolsResponseTypedDict": ".maplepoolsresponse",
+    "MaplePosition": ".mapleposition",
+    "MaplePositionTypedDict": ".mapleposition",
+    "MapleVenue": ".maplevenue",
+    "MapleVenueTypedDict": ".maplevenue",
+    "MapleWithdrawalQueue": ".maplewithdrawalqueue",
+    "MapleWithdrawalQueueTypedDict": ".maplewithdrawalqueue",
     "MarketAllocation": ".marketallocation",
     "MarketAllocationTypedDict": ".marketallocation",
     "MarketDetail": ".marketdetail",
@@ -4405,8 +4457,8 @@ _dynamic_imports: dict[str, str] = {
     "TokenizedAssetsTradeRequestSlippage": ".tokenizedassetstraderequest",
     "TokenizedAssetsTradeRequestSlippageTypedDict": ".tokenizedassetstraderequest",
     "TokenizedAssetsTradeRequestTypedDict": ".tokenizedassetstraderequest",
-    "Settlement": ".tokenizedassetstraderesponse",
     "TokenizedAssetsTradeResponse": ".tokenizedassetstraderesponse",
+    "TokenizedAssetsTradeResponseSettlement": ".tokenizedassetstraderesponse",
     "TokenizedAssetsTradeResponseTypedDict": ".tokenizedassetstraderesponse",
     "TokenizedAssetsTransferRequest": ".tokenizedassetstransferrequest",
     "TokenizedAssetsTransferRequestAction": ".tokenizedassetstransferrequest",
@@ -4708,6 +4760,9 @@ _dynamic_imports: dict[str, str] = {
     "V2EarnBalancesChain": ".v2_earn_balancesop",
     "V2EarnBalancesRequest": ".v2_earn_balancesop",
     "V2EarnBalancesRequestTypedDict": ".v2_earn_balancesop",
+    "V2EarnMaplePoolsChain": ".v2_earn_maple_poolsop",
+    "V2EarnMaplePoolsRequest": ".v2_earn_maple_poolsop",
+    "V2EarnMaplePoolsRequestTypedDict": ".v2_earn_maple_poolsop",
     "V2EarnPendleMarketsDirection": ".v2_earn_pendle_marketsop",
     "V2EarnPendleMarketsMinTvlUsd": ".v2_earn_pendle_marketsop",
     "V2EarnPendleMarketsMinTvlUsdTypedDict": ".v2_earn_pendle_marketsop",
@@ -4769,6 +4824,7 @@ _dynamic_imports: dict[str, str] = {
     "V2BundleRequestChain": ".v2bundlerequest",
     "V2BundleRequestTypedDict": ".v2bundlerequest",
     "V2BundleResponse": ".v2bundleresponse",
+    "V2BundleResponseSettlement": ".v2bundleresponse",
     "V2BundleResponseSwapProvider": ".v2bundleresponse",
     "V2BundleResponseTypedDict": ".v2bundleresponse",
     "V2UserOperation": ".v2useroperation",

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/src/compass_api_sdk/models/earnmanageparams.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 from .aavevenue import AaveVenue, AaveVenueTypedDict
 from .fee import Fee, FeeTypedDict
+from .maplevenue import MapleVenue, MapleVenueTypedDict
 from .pendleptvenue import PendlePTVenue, PendlePTVenueTypedDict
 from .vaultvenue import VaultVenue, VaultVenueTypedDict
 from compass_api_sdk.types import (
@@ -23,13 +24,18 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 EarnManageParamsVenueTypedDict = TypeAliasType(
     "EarnManageParamsVenueTypedDict",
-    Union[VaultVenueTypedDict, AaveVenueTypedDict, PendlePTVenueTypedDict],
+    Union[
+        VaultVenueTypedDict,
+        AaveVenueTypedDict,
+        MapleVenueTypedDict,
+        PendlePTVenueTypedDict,
+    ],
 )
 r"""The earn venue."""
 
 
 EarnManageParamsVenue = Annotated[
-    Union[AaveVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
+    Union[AaveVenue, MapleVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
 ]
 r"""The earn venue."""
 
@@ -44,15 +50,16 @@ class EarnManageParamsAction(str, Enum):
 EarnManageParamsAmountTypedDict = TypeAliasType(
     "EarnManageParamsAmountTypedDict", Union[float, str]
 )
-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."""
+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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0."""
 
 
 EarnManageParamsAmount = TypeAliasType("EarnManageParamsAmount", Union[float, str])
-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."""
+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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0."""
 
 
 class EarnManageParamsTypedDict(TypedDict):
-    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave/Pendle PT).
+    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave/Pendle
+    PT/Maple).
 
     Used by multicall/bundle endpoint to specify manage actions. EarnManageRequest
     inherits from this class.
@@ -63,7 +70,7 @@ class EarnManageParamsTypedDict(TypedDict):
     action: EarnManageParamsAction
     r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
     amount: EarnManageParamsAmountTypedDict
-    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."""
+    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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0."""
     action_type: Literal["V2_MANAGE"]
     r"""Action type identifier for manage operations."""
     fee: NotRequired[Nullable[FeeTypedDict]]
@@ -71,7 +78,8 @@ class EarnManageParamsTypedDict(TypedDict):
 
 
 class EarnManageParams(BaseModel):
-    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave/Pendle PT).
+    r"""Parameters for earn manage operations (deposit/withdraw to vault/Aave/Pendle
+    PT/Maple).
 
     Used by multicall/bundle endpoint to specify manage actions. EarnManageRequest
     inherits from this class.
@@ -84,7 +92,7 @@ class EarnManageParams(BaseModel):
     r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
 
     amount: EarnManageParamsAmount
-    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."""
+    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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0."""
 
     ACTION_TYPE: Annotated[
         Annotated[

{compass_api_sdk-2.2.118 → compass_api_sdk-2.2.119}/src/compass_api_sdk/models/earnmanagerequest.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 from .aavevenue import AaveVenue, AaveVenueTypedDict
 from .fee import Fee, FeeTypedDict
+from .maplevenue import MapleVenue, MapleVenueTypedDict
 from .pendleptvenue import PendlePTVenue, PendlePTVenueTypedDict
 from .vaultvenue import VaultVenue, VaultVenueTypedDict
 from compass_api_sdk.types import (
@@ -23,13 +24,18 @@ from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
 
 EarnManageRequestVenueTypedDict = TypeAliasType(
     "EarnManageRequestVenueTypedDict",
-    Union[VaultVenueTypedDict, AaveVenueTypedDict, PendlePTVenueTypedDict],
+    Union[
+        VaultVenueTypedDict,
+        AaveVenueTypedDict,
+        MapleVenueTypedDict,
+        PendlePTVenueTypedDict,
+    ],
 )
 r"""The earn venue."""
 
 
 EarnManageRequestVenue = Annotated[
-    Union[AaveVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
+    Union[AaveVenue, MapleVenue, PendlePTVenue, VaultVenue], Field(discriminator="TYPE")
 ]
 r"""The earn venue."""
 
@@ -44,11 +50,11 @@ class EarnManageRequestAction(str, Enum):
 EarnManageRequestAmountTypedDict = TypeAliasType(
     "EarnManageRequestAmountTypedDict", Union[float, str]
 )
-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."""
+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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0."""
 
 
 EarnManageRequestAmount = TypeAliasType("EarnManageRequestAmount", Union[float, str])
-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."""
+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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). Provide as a decimal in token units (not wei); must be > 0."""
 
 
 class EarnManageRequestChain(str, Enum):
@@ -73,7 +79,7 @@ class EarnManageRequestTypedDict(TypedDict):
     action: EarnManageRequestAction
     r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
     amount: EarnManageRequestAmountTypedDict
-    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."""
+    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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). 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: EarnManageRequestChain
@@ -99,7 +105,7 @@ class EarnManageRequest(BaseModel):
     r"""Whether you are depositing into or withdrawing from the given Earn `venue`."""
 
     amount: EarnManageRequestAmount
-    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."""
+    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); for MAPLE, this is the pool's underlying asset (USDC for syrupUSDC, USDT for syrupUSDT). 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."""