compass_api_sdk 0.9.39__tar.gz → 0.9.40__tar.gz

{compass_api_sdk-0.9.39 → compass_api_sdk-0.9.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.9.39
+Version: 0.9.40
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2
@@ -245,6 +245,7 @@ with CompassAPI(
 * [positions](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#positions) - List User's Market Positions
 * [market](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#market) - Get Market Data
 * [markets](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#markets) - List Market Data
+* [quote](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#quote) - Get Quote
 * [buy_pt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#buy_pt) - Buy Principal Token (PT)
 * [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)

{compass_api_sdk-0.9.39 → compass_api_sdk-0.9.40}/README-PYPI.md

@@ -228,6 +228,7 @@ with CompassAPI(
 * [positions](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#positions) - List User's Market Positions
 * [market](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#market) - Get Market Data
 * [markets](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#markets) - List Market Data
+* [quote](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#quote) - Get Quote
 * [buy_pt](https://github.com/CompassLabs/mono/blob/master/docs/sdks/pendle/README.md#buy_pt) - Buy Principal Token (PT)
 * [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)

{compass_api_sdk-0.9.39 → compass_api_sdk-0.9.40}/pyproject.toml

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

{compass_api_sdk-0.9.39 → compass_api_sdk-0.9.40}/src/compass_api_sdk/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "compass_api_sdk"
-__version__: str = "0.9.39"
+__version__: str = "0.9.40"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.648.1"
-__user_agent__: str = "speakeasy-sdk/python 0.9.39 2.648.1 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.648.7"
+__user_agent__: str = "speakeasy-sdk/python 0.9.40 2.648.7 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-0.9.39 → compass_api_sdk-0.9.40}/src/compass_api_sdk/models/__init__.py

@@ -524,6 +524,15 @@ if TYPE_CHECKING:
         PendlePositionsRequest,
         PendlePositionsRequestTypedDict,
     )
+    from .pendle_quoteop import (
+        PendleQuoteAmount,
+        PendleQuoteAmountTypedDict,
+        PendleQuoteChain,
+        PendleQuoteRequest,
+        PendleQuoteRequestTypedDict,
+        TokenType,
+        TradeType,
+    )
     from .pendleaddliquidityparams import (
         PendleAddLiquidityParams,
         PendleAddLiquidityParamsAmount,
@@ -564,6 +573,10 @@ if TYPE_CHECKING:
         PendleGetMarketResponse,
         PendleGetMarketResponseTypedDict,
     )
+    from .pendlegetquoteresponse import (
+        PendleGetQuoteResponse,
+        PendleGetQuoteResponseTypedDict,
+    )
     from .pendlegetuserpositionresponse import (
         PendleGetUserPositionResponse,
         PendleGetUserPositionResponseTypedDict,
@@ -1353,6 +1366,8 @@ __all__ = [
     "PendleBuyYtRequestTypedDict",
     "PendleGetMarketResponse",
     "PendleGetMarketResponseTypedDict",
+    "PendleGetQuoteResponse",
+    "PendleGetQuoteResponseTypedDict",
     "PendleGetUserPositionResponse",
     "PendleGetUserPositionResponseTypedDict",
     "PendleListMarketsResponse",
@@ -1373,6 +1388,11 @@ __all__ = [
     "PendlePositionsChain",
     "PendlePositionsRequest",
     "PendlePositionsRequestTypedDict",
+    "PendleQuoteAmount",
+    "PendleQuoteAmountTypedDict",
+    "PendleQuoteChain",
+    "PendleQuoteRequest",
+    "PendleQuoteRequestTypedDict",
     "PendleRedeemYieldParams",
     "PendleRedeemYieldParamsTypedDict",
     "PendleRedeemYieldRequest",
@@ -1513,6 +1533,8 @@ __all__ = [
     "TokenTransferRequestToken",
     "TokenTransferRequestTokenTypedDict",
     "TokenTransferRequestTypedDict",
+    "TokenType",
+    "TradeType",
     "Transaction",
     "TransactionTypedDict",
     "TxResponse",
@@ -2039,6 +2061,13 @@ _dynamic_imports: dict[str, str] = {
     "PendlePositionsChain": ".pendle_positionsop",
     "PendlePositionsRequest": ".pendle_positionsop",
     "PendlePositionsRequestTypedDict": ".pendle_positionsop",
+    "PendleQuoteAmount": ".pendle_quoteop",
+    "PendleQuoteAmountTypedDict": ".pendle_quoteop",
+    "PendleQuoteChain": ".pendle_quoteop",
+    "PendleQuoteRequest": ".pendle_quoteop",
+    "PendleQuoteRequestTypedDict": ".pendle_quoteop",
+    "TokenType": ".pendle_quoteop",
+    "TradeType": ".pendle_quoteop",
     "PendleAddLiquidityParams": ".pendleaddliquidityparams",
     "PendleAddLiquidityParamsAmount": ".pendleaddliquidityparams",
     "PendleAddLiquidityParamsAmountTypedDict": ".pendleaddliquidityparams",
@@ -2065,6 +2094,8 @@ _dynamic_imports: dict[str, str] = {
     "PendleBuyYtRequestTypedDict": ".pendlebuyytrequest",
     "PendleGetMarketResponse": ".pendlegetmarketresponse",
     "PendleGetMarketResponseTypedDict": ".pendlegetmarketresponse",
+    "PendleGetQuoteResponse": ".pendlegetquoteresponse",
+    "PendleGetQuoteResponseTypedDict": ".pendlegetquoteresponse",
     "PendleGetUserPositionResponse": ".pendlegetuserpositionresponse",
     "PendleGetUserPositionResponseTypedDict": ".pendlegetuserpositionresponse",
     "PendleListMarketsResponse": ".pendlelistmarketsresponse",

compass_api_sdk-0.9.40/src/compass_api_sdk/models/pendle_quoteop.py

@@ -0,0 +1,128 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+from pydantic import model_serializer
+from typing import Union
+from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict
+
+
+class PendleQuoteChain(str, Enum):
+    r"""The chain to use."""
+
+    BASE_MAINNET = "base:mainnet"
+    ETHEREUM_MAINNET = "ethereum:mainnet"
+    ARBITRUM_MAINNET = "arbitrum:mainnet"
+
+
+PendleQuoteAmountTypedDict = TypeAliasType(
+    "PendleQuoteAmountTypedDict", Union[float, str]
+)
+r"""The quantity to trade."""
+
+
+PendleQuoteAmount = TypeAliasType("PendleQuoteAmount", Union[float, str])
+r"""The quantity to trade."""
+
+
+class TokenType(str, Enum):
+    r"""Specifies the token to quote (`PT`, `YT`, or `LP`)"""
+
+    PT = "PT"
+    YT = "YT"
+    LP = "LP"
+
+
+class TradeType(str, Enum):
+    r"""Specifies the trade direction (`BUY` or `SELL`)"""
+
+    BUY = "BUY"
+    SELL = "SELL"
+
+
+class PendleQuoteRequestTypedDict(TypedDict):
+    amount: PendleQuoteAmountTypedDict
+    r"""The quantity to trade."""
+    chain: PendleQuoteChain
+    r"""The chain to use."""
+    block: NotRequired[Nullable[int]]
+    r"""Optional block number (defaults to latest)."""
+    market_address: str
+    r"""The market address of the desired position."""
+    token_type: TokenType
+    r"""Specifies the token to quote (`PT`, `YT`, or `LP`)"""
+    trade_type: TradeType
+    r"""Specifies the trade direction (`BUY` or `SELL`)"""
+
+
+class PendleQuoteRequest(BaseModel):
+    amount: Annotated[
+        PendleQuoteAmount,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""The quantity to trade."""
+
+    chain: Annotated[
+        PendleQuoteChain,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = PendleQuoteChain.ARBITRUM_MAINNET
+    r"""The chain to use."""
+
+    block: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Optional block number (defaults to latest)."""
+
+    market_address: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538"
+    r"""The market address of the desired position."""
+
+    token_type: Annotated[
+        TokenType, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = TokenType.PT
+    r"""Specifies the token to quote (`PT`, `YT`, or `LP`)"""
+
+    trade_type: Annotated[
+        TradeType, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ] = TradeType.BUY
+    r"""Specifies the trade direction (`BUY` or `SELL`)"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["block"]
+        nullable_fields = ["block"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

compass_api_sdk-0.9.40/src/compass_api_sdk/models/pendlegetquoteresponse.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class PendleGetQuoteResponseTypedDict(TypedDict):
+    quote: str
+    r"""A quote for the specified trade, detailing the expected amount of tokens received based on the `trade_type` and `token_type`."""
+
+
+class PendleGetQuoteResponse(BaseModel):
+    quote: str
+    r"""A quote for the specified trade, detailing the expected amount of tokens received based on the `trade_type` and `token_type`."""

{compass_api_sdk-0.9.39 → compass_api_sdk-0.9.40}/src/compass_api_sdk/pendle.py

@@ -756,6 +756,224 @@ class Pendle(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def quote(
+        self,
+        *,
+        chain: models.PendleQuoteChain = models.PendleQuoteChain.ARBITRUM_MAINNET,
+        market_address: str = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
+        amount: Union[models.PendleQuoteAmount, models.PendleQuoteAmountTypedDict],
+        token_type: models.TokenType = models.TokenType.PT,
+        trade_type: models.TradeType = models.TradeType.BUY,
+        block: OptionalNullable[int] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.PendleGetQuoteResponse:
+        r"""Get Quote
+
+        Retrieve a quote for trading Principal Token (PT), Yield Token (YT), or Liquidity
+        Provider Token (LP) on Pendle.
+
+        For `BUY`, `amount` is the quantity of the Underlying Token to spend, and the quote returns the amount of `token_type` received.
+
+        For `SELL`, `amount` is the quantity of `token_type` to sell, and the quote returns the amount of Underlying Token received.
+
+        :param chain: The chain to use.
+        :param market_address: The market address of the desired position.
+        :param amount: The quantity to trade.
+        :param token_type: Specifies the token to quote (`PT`, `YT`, or `LP`)
+        :param trade_type: Specifies the trade direction (`BUY` or `SELL`)
+        :param block: Optional block number (defaults to latest).
+        :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.PendleQuoteRequest(
+            chain=chain,
+            block=block,
+            market_address=market_address,
+            amount=amount,
+            token_type=token_type,
+            trade_type=trade_type,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v0/pendle/quote",
+            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,
+            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_quote",
+                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_response(
+                models.PendleGetQuoteResponse, http_res
+            )
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.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 quote_async(
+        self,
+        *,
+        chain: models.PendleQuoteChain = models.PendleQuoteChain.ARBITRUM_MAINNET,
+        market_address: str = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
+        amount: Union[models.PendleQuoteAmount, models.PendleQuoteAmountTypedDict],
+        token_type: models.TokenType = models.TokenType.PT,
+        trade_type: models.TradeType = models.TradeType.BUY,
+        block: OptionalNullable[int] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.PendleGetQuoteResponse:
+        r"""Get Quote
+
+        Retrieve a quote for trading Principal Token (PT), Yield Token (YT), or Liquidity
+        Provider Token (LP) on Pendle.
+
+        For `BUY`, `amount` is the quantity of the Underlying Token to spend, and the quote returns the amount of `token_type` received.
+
+        For `SELL`, `amount` is the quantity of `token_type` to sell, and the quote returns the amount of Underlying Token received.
+
+        :param chain: The chain to use.
+        :param market_address: The market address of the desired position.
+        :param amount: The quantity to trade.
+        :param token_type: Specifies the token to quote (`PT`, `YT`, or `LP`)
+        :param trade_type: Specifies the trade direction (`BUY` or `SELL`)
+        :param block: Optional block number (defaults to latest).
+        :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.PendleQuoteRequest(
+            chain=chain,
+            block=block,
+            market_address=market_address,
+            amount=amount,
+            token_type=token_type,
+            trade_type=trade_type,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v0/pendle/quote",
+            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,
+            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_quote",
+                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_response(
+                models.PendleGetQuoteResponse, http_res
+            )
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.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 buy_pt(
         self,
         *,