compass_api_sdk 0.9.40__py3-none-any.whl → 0.9.42__py3-none-any.whl

compass_api_sdk/pendle.py

@@ -4,30 +4,33 @@ from .basesdk import BaseSDK
 from compass_api_sdk import errors, models, utils
 from compass_api_sdk._hooks import HookContext
 from compass_api_sdk.types import OptionalNullable, UNSET
+from compass_api_sdk.utils.unmarshal_json_response import unmarshal_json_response
 from typing import Any, Mapping, Optional, Union
 
 
 class Pendle(BaseSDK):
-    def position(
+    def market(
         self,
         *,
-        chain: models.PendlePositionChain = models.PendlePositionChain.ARBITRUM_MAINNET,
-        user_address: str = "0xB7954A07213413b2ec6Faa1360f56a498eACe10b",
+        chain: models.PendleMarketChain = models.PendleMarketChain.ARBITRUM_MAINNET,
         market_address: str = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
         block: OptionalNullable[int] = UNSET,
+        user_address: 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.PendleGetUserPositionResponse:
-        r"""Check User's Market Position
+    ) -> models.PendleGetMarketResponse:
+        r"""Get Market & User Position
 
-        Check the SY, PT, YT and Underlying Token positions for a given market.
+        Get the market's implied APY, maturity date and the associated token data.
+
+        The user position is only included if 'user_address' parameter is included.
 
         :param chain: The chain to use.
-        :param user_address: The user address of the desired position.
         :param market_address: The market address of the desired position.
         :param block: Optional block number (defaults to latest).
+        :param user_address: The user address of the desired market position. Only include if you would like the user position included in the response. Defaults to `None`.
         :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
@@ -43,16 +46,16 @@ class Pendle(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.PendlePositionRequest(
+        request = models.PendleMarketRequest(
             chain=chain,
             block=block,
-            user_address=user_address,
             market_address=market_address,
+            user_address=user_address,
         )
 
         req = self._build_request(
             method="GET",
-            path="/v0/pendle/position",
+            path="/v0/pendle/market",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -78,7 +81,7 @@ class Pendle(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="pendle_position",
+                operation_id="pendle_market",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -89,11 +92,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
-                models.PendleGetUserPositionResponse, http_res
-            )
+            return unmarshal_json_response(models.PendleGetMarketResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -106,26 +107,28 @@ class Pendle(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def position_async(
+    async def market_async(
         self,
         *,
-        chain: models.PendlePositionChain = models.PendlePositionChain.ARBITRUM_MAINNET,
-        user_address: str = "0xB7954A07213413b2ec6Faa1360f56a498eACe10b",
+        chain: models.PendleMarketChain = models.PendleMarketChain.ARBITRUM_MAINNET,
         market_address: str = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
         block: OptionalNullable[int] = UNSET,
+        user_address: 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.PendleGetUserPositionResponse:
-        r"""Check User's Market Position
+    ) -> models.PendleGetMarketResponse:
+        r"""Get Market & User Position
 
-        Check the SY, PT, YT and Underlying Token positions for a given market.
+        Get the market's implied APY, maturity date and the associated token data.
+
+        The user position is only included if 'user_address' parameter is included.
 
         :param chain: The chain to use.
-        :param user_address: The user address of the desired position.
         :param market_address: The market address of the desired position.
         :param block: Optional block number (defaults to latest).
+        :param user_address: The user address of the desired market position. Only include if you would like the user position included in the response. Defaults to `None`.
         :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
@@ -141,16 +144,16 @@ class Pendle(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.PendlePositionRequest(
+        request = models.PendleMarketRequest(
             chain=chain,
             block=block,
-            user_address=user_address,
             market_address=market_address,
+            user_address=user_address,
         )
 
         req = self._build_request_async(
             method="GET",
-            path="/v0/pendle/position",
+            path="/v0/pendle/market",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -176,7 +179,7 @@ class Pendle(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="pendle_position",
+                operation_id="pendle_market",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -187,11 +190,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
-                models.PendleGetUserPositionResponse, http_res
-            )
+            return unmarshal_json_response(models.PendleGetMarketResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -279,11 +280,11 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
+            return unmarshal_json_response(
                 models.PendleListUserPositionsResponse, http_res
             )
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -371,201 +372,11 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
+            return unmarshal_json_response(
                 models.PendleListUserPositionsResponse, 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 market(
-        self,
-        *,
-        chain: models.PendleMarketChain = models.PendleMarketChain.ARBITRUM_MAINNET,
-        market_address: str = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
-        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.PendleGetMarketResponse:
-        r"""Get Market Data
-
-        Get the market's implied APY, maturity date and the associated token data.
-
-        :param chain: The chain to use.
-        :param market_address: The market address of the desired position.
-        :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.PendleMarketRequest(
-            chain=chain,
-            block=block,
-            market_address=market_address,
-        )
-
-        req = self._build_request(
-            method="GET",
-            path="/v0/pendle/market",
-            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_market",
-                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.PendleGetMarketResponse, 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 market_async(
-        self,
-        *,
-        chain: models.PendleMarketChain = models.PendleMarketChain.ARBITRUM_MAINNET,
-        market_address: str = "0x46d62a8dede1bf2d0de04f2ed863245cbba5e538",
-        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.PendleGetMarketResponse:
-        r"""Get Market Data
-
-        Get the market's implied APY, maturity date and the associated token data.
-
-        :param chain: The chain to use.
-        :param market_address: The market address of the desired position.
-        :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.PendleMarketRequest(
-            chain=chain,
-            block=block,
-            market_address=market_address,
-        )
-
-        req = self._build_request_async(
-            method="GET",
-            path="/v0/pendle/market",
-            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_market",
-                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.PendleGetMarketResponse, http_res
-            )
-        if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -650,11 +461,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
-                models.PendleListMarketsResponse, http_res
-            )
+            return unmarshal_json_response(models.PendleListMarketsResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -739,11 +548,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
-                models.PendleListMarketsResponse, http_res
-            )
+            return unmarshal_json_response(models.PendleListMarketsResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -848,11 +655,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
-                models.PendleGetQuoteResponse, http_res
-            )
+            return unmarshal_json_response(models.PendleGetQuoteResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -957,11 +762,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(
-                models.PendleGetQuoteResponse, http_res
-            )
+            return unmarshal_json_response(models.PendleGetQuoteResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1063,9 +866,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1167,9 +970,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1271,9 +1074,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1375,9 +1178,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1479,9 +1282,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1583,9 +1386,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1687,9 +1490,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1791,9 +1594,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1887,9 +1690,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -1983,9 +1786,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -2091,9 +1894,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -2199,9 +2002,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -2308,9 +2111,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)
@@ -2417,9 +2220,9 @@ class Pendle(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return utils.unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TxResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
-            response_data = utils.unmarshal_json_response(
+            response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
             )
             raise errors.HTTPValidationError(response_data, http_res)