compass_api_sdk 0.9.3__tar.gz → 0.9.4__tar.gz

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.9.3
+Version: 0.9.4
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2
@@ -245,6 +245,7 @@ with CompassAPI(
 * [sell_pt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#sell_pt) - Sell Principal Token (PT)
 * [buy_yt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#buy_yt) - Buy Yield Token (YT)
 * [sell_yt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#sell_yt) - Sell Yield Token (YT)
+* [redeem_yield](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#redeem_yield) - Redeem Claimable Yield
 
 ### [sky](https://github.com/CompassLabs/mono/blob/master/docs/sdks/sky/README.md)
 

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/README-PYPI.md

@@ -228,6 +228,7 @@ with CompassAPI(
 * [sell_pt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#sell_pt) - Sell Principal Token (PT)
 * [buy_yt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#buy_yt) - Buy Yield Token (YT)
 * [sell_yt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#sell_yt) - Sell Yield Token (YT)
+* [redeem_yield](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#redeem_yield) - Redeem Claimable Yield
 
 ### [sky](https://github.com/CompassLabs/mono/blob/master/docs/sdks/sky/README.md)
 

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compass_api_sdk"
-version = "0.9.3"
+version = "0.9.4"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/src/compass_api_sdk/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "compass_api_sdk"
-__version__: str = "0.9.3"
+__version__: str = "0.9.4"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.616.1"
-__user_agent__: str = "speakeasy-sdk/python 0.9.3 2.616.1 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.618.0"
+__user_agent__: str = "speakeasy-sdk/python 0.9.4 2.618.0 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/src/compass_api_sdk/models/__init__.py

@@ -605,6 +605,14 @@ if TYPE_CHECKING:
         PendleListUserPositionsResponseTypedDict,
     )
     from .pendlemarket import PendleMarket, PendleMarketTypedDict
+    from .pendleredeemyieldparams import (
+        PendleRedeemYieldParams,
+        PendleRedeemYieldParamsTypedDict,
+    )
+    from .pendleredeemyieldrequest import (
+        PendleRedeemYieldRequest,
+        PendleRedeemYieldRequestTypedDict,
+    )
     from .pendlesellptparams import (
         PendleSellPtParams,
         PendleSellPtParamsAmount,
@@ -1356,6 +1364,10 @@ __all__ = [
     "PendlePositionsChain",
     "PendlePositionsRequest",
     "PendlePositionsRequestTypedDict",
+    "PendleRedeemYieldParams",
+    "PendleRedeemYieldParamsTypedDict",
+    "PendleRedeemYieldRequest",
+    "PendleRedeemYieldRequestTypedDict",
     "PendleSellPtParams",
     "PendleSellPtParamsAmount",
     "PendleSellPtParamsAmountTypedDict",
@@ -2030,6 +2042,10 @@ _dynamic_imports: dict[str, str] = {
     "PendleListUserPositionsResponseTypedDict": ".pendlelistuserpositionsresponse",
     "PendleMarket": ".pendlemarket",
     "PendleMarketTypedDict": ".pendlemarket",
+    "PendleRedeemYieldParams": ".pendleredeemyieldparams",
+    "PendleRedeemYieldParamsTypedDict": ".pendleredeemyieldparams",
+    "PendleRedeemYieldRequest": ".pendleredeemyieldrequest",
+    "PendleRedeemYieldRequestTypedDict": ".pendleredeemyieldrequest",
     "PendleSellPtParams": ".pendlesellptparams",
     "PendleSellPtParamsAmount": ".pendlesellptparams",
     "PendleSellPtParamsAmountTypedDict": ".pendlesellptparams",

compass_api_sdk-0.9.4/src/compass_api_sdk/models/pendleredeemyieldparams.py

@@ -0,0 +1,28 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional
+from typing_extensions import Annotated, TypedDict
+
+
+class PendleRedeemYieldParamsTypedDict(TypedDict):
+    market_address: str
+    r"""The address of the market identifying which Yield Token (YT) you would like to claim yield from."""
+    action_type: Literal["PENDLE_REDEEM_YIELD"]
+
+
+class PendleRedeemYieldParams(BaseModel):
+    market_address: str
+    r"""The address of the market identifying which Yield Token (YT) you would like to claim yield from."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["PENDLE_REDEEM_YIELD"]],
+            AfterValidator(validate_const("PENDLE_REDEEM_YIELD")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "PENDLE_REDEEM_YIELD"

compass_api_sdk-0.9.4/src/compass_api_sdk/models/pendleredeemyieldrequest.py

@@ -0,0 +1,39 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from compass_api_sdk.types import BaseModel
+from compass_api_sdk.utils import validate_const
+import pydantic
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional
+from typing_extensions import Annotated, TypedDict
+
+
+class PendleRedeemYieldRequestTypedDict(TypedDict):
+    market_address: str
+    r"""The address of the market identifying which Yield Token (YT) you would like to claim yield from."""
+    chain: Chain
+    r"""The chain to use."""
+    sender: str
+    r"""The address of the transaction sender."""
+    action_type: Literal["PENDLE_REDEEM_YIELD"]
+
+
+class PendleRedeemYieldRequest(BaseModel):
+    market_address: str
+    r"""The address of the market identifying which Yield Token (YT) you would like to claim yield from."""
+
+    chain: Chain
+    r"""The chain to use."""
+
+    sender: str
+    r"""The address of the transaction sender."""
+
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["PENDLE_REDEEM_YIELD"]],
+            AfterValidator(validate_const("PENDLE_REDEEM_YIELD")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "PENDLE_REDEEM_YIELD"

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/src/compass_api_sdk/models/useroperation.py

@@ -47,6 +47,10 @@ from .morphowithdrawcollateralparams import (
 from .morphowithdrawparams import MorphoWithdrawParams, MorphoWithdrawParamsTypedDict
 from .pendlebuyptparams import PendleBuyPtParams, PendleBuyPtParamsTypedDict
 from .pendlebuyytparams import PendleBuyYtParams, PendleBuyYtParamsTypedDict
+from .pendleredeemyieldparams import (
+    PendleRedeemYieldParams,
+    PendleRedeemYieldParamsTypedDict,
+)
 from .pendlesellptparams import PendleSellPtParams, PendleSellPtParamsTypedDict
 from .pendlesellytparams import PendleSellYtParams, PendleSellYtParamsTypedDict
 from .skybuyparams import SkyBuyParams, SkyBuyParamsTypedDict
@@ -89,39 +93,40 @@ from typing_extensions import Annotated, TypeAliasType, TypedDict
 BodyTypedDict = TypeAliasType(
     "BodyTypedDict",
     Union[
-        UnwrapWethParamsTypedDict,
+        PendleRedeemYieldParamsTypedDict,
         WrapEthParamsTypedDict,
-        SkyWithdrawParamsTypedDict,
-        MorphoSetVaultAllowanceParamsTypedDict,
+        UnwrapWethParamsTypedDict,
+        SkySellParamsTypedDict,
         PendleSellYtParamsTypedDict,
         UniswapWithdrawLiquidityProvisionParamsTypedDict,
-        PendleBuyYtParamsTypedDict,
-        SkySellParamsTypedDict,
+        SkyWithdrawParamsTypedDict,
+        SkyDepositParamsTypedDict,
         AerodromeSlipstreamWithdrawLiquidityProvisionParamsTypedDict,
+        SkyBuyParamsTypedDict,
+        PendleBuyYtParamsTypedDict,
         PendleBuyPtParamsTypedDict,
-        SkyDepositParamsTypedDict,
         PendleSellPtParamsTypedDict,
-        SkyBuyParamsTypedDict,
+        MorphoSetVaultAllowanceParamsTypedDict,
         MorphoDepositParamsTypedDict,
+        TokenTransferErc20ParamsTypedDict,
+        AaveWithdrawParamsTypedDict,
         IncreaseAllowanceParamsTypedDict,
         MorphoWithdrawParamsTypedDict,
-        AaveWithdrawParamsTypedDict,
-        TokenTransferErc20ParamsTypedDict,
         AaveSupplyParamsTypedDict,
-        MorphoBorrowParamsTypedDict,
-        MorphoSupplyCollateralParamsTypedDict,
-        MorphoRepayParamsTypedDict,
         MorphoWithdrawCollateralParamsTypedDict,
         AaveRepayParamsTypedDict,
+        MorphoSupplyCollateralParamsTypedDict,
+        MorphoRepayParamsTypedDict,
+        MorphoBorrowParamsTypedDict,
         AaveBorrowParamsTypedDict,
+        AerodromeSlipstreamSellExactlyParamsTypedDict,
         UniswapIncreaseLiquidityProvisionParamsTypedDict,
         AerodromeSlipstreamIncreaseLiquidityProvisionParamsTypedDict,
         AerodromeSlipstreamBuyExactlyParamsTypedDict,
-        AerodromeSlipstreamSellExactlyParamsTypedDict,
         UniswapBuyExactlyParamsTypedDict,
         UniswapSellExactlyParamsTypedDict,
-        AerodromeSlipstreamMintLiquidityProvisionParamsTypedDict,
         UniswapMintLiquidityProvisionParamsTypedDict,
+        AerodromeSlipstreamMintLiquidityProvisionParamsTypedDict,
     ],
 )
 
@@ -161,6 +166,7 @@ Body = Annotated[
         Annotated[MorphoWithdrawCollateralParams, Tag("MORPHO_WITHDRAW_COLLATERAL")],
         Annotated[PendleBuyPtParams, Tag("PENDLE_BUY_PT")],
         Annotated[PendleBuyYtParams, Tag("PENDLE_BUY_YT")],
+        Annotated[PendleRedeemYieldParams, Tag("PENDLE_REDEEM_YIELD")],
         Annotated[PendleSellPtParams, Tag("PENDLE_SELL_PT")],
         Annotated[PendleSellYtParams, Tag("PENDLE_SELL_YT")],
         Annotated[SkyBuyParams, Tag("SKY_BUY")],

{compass_api_sdk-0.9.3 → compass_api_sdk-0.9.4}/src/compass_api_sdk/pendle.py

@@ -1743,3 +1743,217 @@ class Pendle(BaseSDK):
             http_res_text,
             http_res,
         )
+
+    def redeem_yield(
+        self,
+        *,
+        market_address: str,
+        chain: models.Chain,
+        sender: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.TxResponse:
+        r"""Redeem Claimable Yield
+
+        Redeem claimable yield from the market's associated Yield Token (YT).
+
+        :param market_address: The address of the market identifying which Yield Token (YT) you would like to claim yield from.
+        :param chain: The chain to use.
+        :param sender: The address of the transaction sender.
+        :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.PendleRedeemYieldRequest(
+            market_address=market_address,
+            chain=chain,
+            sender=sender,
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/v0/pendle/redeem_yield",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            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,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.PendleRedeemYieldRequest
+            ),
+            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="pendle_redeem_yield",
+                oauth2_scopes=[],
+                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 utils.unmarshal_json(http_res.text, models.TxResponse)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.unmarshal_json(
+                http_res.text, errors.HTTPValidationErrorData
+            )
+            raise errors.HTTPValidationError(data=response_data)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
+        raise errors.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    async def redeem_yield_async(
+        self,
+        *,
+        market_address: str,
+        chain: models.Chain,
+        sender: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.TxResponse:
+        r"""Redeem Claimable Yield
+
+        Redeem claimable yield from the market's associated Yield Token (YT).
+
+        :param market_address: The address of the market identifying which Yield Token (YT) you would like to claim yield from.
+        :param chain: The chain to use.
+        :param sender: The address of the transaction sender.
+        :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.PendleRedeemYieldRequest(
+            market_address=market_address,
+            chain=chain,
+            sender=sender,
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/v0/pendle/redeem_yield",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            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,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request, False, False, "json", models.PendleRedeemYieldRequest
+            ),
+            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="pendle_redeem_yield",
+                oauth2_scopes=[],
+                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 utils.unmarshal_json(http_res.text, models.TxResponse)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.unmarshal_json(
+                http_res.text, errors.HTTPValidationErrorData
+            )
+            raise errors.HTTPValidationError(data=response_data)
+        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.status_code, http_res_text, http_res
+            )
+        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.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise errors.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )