compass_api_sdk 1.0.1__tar.gz → 1.1.0__tar.gz

{compass_api_sdk-1.0.1 → compass_api_sdk-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 1.0.1
+Version: 1.1.0
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.9.2
@@ -237,8 +237,8 @@ with CompassAPI(
 
 * [ethena_vault](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_vault) - Get Vault & User Position
 * [ethena_deposit](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_deposit) - Deposit USDe
-* [ethena_withdraw](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_withdraw) - Withdraw USDe
 * [ethena_request](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_request) - Request to Withdraw USDe
+* [ethena_unstake](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_unstake) - Unstake USDe
 
 ### [morpho](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/morpho/README.md)
 

{compass_api_sdk-1.0.1 → compass_api_sdk-1.1.0}/README-PYPI.md

@@ -220,8 +220,8 @@ with CompassAPI(
 
 * [ethena_vault](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_vault) - Get Vault & User Position
 * [ethena_deposit](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_deposit) - Deposit USDe
-* [ethena_withdraw](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_withdraw) - Withdraw USDe
 * [ethena_request](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_request) - Request to Withdraw USDe
+* [ethena_unstake](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/ethena/README.md#ethena_unstake) - Unstake USDe
 
 ### [morpho](https://github.com/CompassLabs/mono/blob/master/python-sdk/docs/sdks/morpho/README.md)
 

{compass_api_sdk-1.0.1 → compass_api_sdk-1.1.0}/pyproject.toml

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

{compass_api_sdk-1.0.1 → compass_api_sdk-1.1.0}/src/compass_api_sdk/_version.py

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

{compass_api_sdk-1.0.1 → compass_api_sdk-1.1.0}/src/compass_api_sdk/ethena.py

@@ -427,38 +427,35 @@ class Ethena(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def ethena_withdraw(
+    def ethena_request(
         self,
         *,
         amount: Any,
-        chain: models.EthenaWithdrawRequestChain,
+        chain: models.EthenaRequestToWithdrawRequestChain,
         sender: str,
-        receiver: 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.TransactionResponse:
-        r"""Withdraw USDe
+    ) -> models.EthenaRequestToWithdrawTransactionResponse:
+        r"""Request to Withdraw USDe
 
-        Withdraw deposited USDe from Ethena's vault and cease earning passive yield.
+        Request to withdraw deposited USDe from Ethena's vault.
 
-        The passive yield earned on USDe deposits is represented by the increased value of
-        the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
-        for the intial USDe deposited and any accrued yield since depositing.
-        <Info>
-        **Required Allowances**
+        The Ethena vault requires a cooldown period. Once a request to withdraw a specified
+        amount of USDe has been submitted, the alloted cooldown period must pass before the
+        withdraw USDe transaction can be submitted.
 
-        In order to make this transaction, token allowances need to be set for the following contracts.
+        If an additional amount of USDe is requested to be withdrawn anytime before
+        withdrawing the originally requested amount, the cooldown period restarts.
 
-        - `EthenaVault`
-        </Info>
+        Yield is not earned on USDe while in its cooldown period.
 
+        An allowance does not have to be set to initiate the cooldown period.
 
-        :param amount: The amount of USDe to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be withdrawn.
+        :param amount: The amount of USDe to request to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be requested to be withdrawn.
         :param chain:
         :param sender: The address of the transaction sender.
-        :param receiver: The address which will receive the USDe withdrawn. Defaults to the 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
@@ -474,16 +471,15 @@ class Ethena(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.EthenaWithdrawRequest(
+        request = models.EthenaRequestToWithdrawRequest(
             amount=amount,
-            receiver=receiver,
             chain=chain,
             sender=sender,
         )
 
         req = self._build_request(
             method="POST",
-            path="/v1/ethena/withdraw",
+            path="/v1/ethena/request",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -495,7 +491,7 @@ class Ethena(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.EthenaWithdrawRequest
+                request, False, False, "json", models.EthenaRequestToWithdrawRequest
             ),
             timeout_ms=timeout_ms,
         )
@@ -512,7 +508,7 @@ class Ethena(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="v1_ethena_withdraw",
+                operation_id="v1_ethena_request",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -523,7 +519,9 @@ class Ethena(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TransactionResponse, http_res)
+            return unmarshal_json_response(
+                models.EthenaRequestToWithdrawTransactionResponse, http_res
+            )
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -538,38 +536,35 @@ class Ethena(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def ethena_withdraw_async(
+    async def ethena_request_async(
         self,
         *,
         amount: Any,
-        chain: models.EthenaWithdrawRequestChain,
+        chain: models.EthenaRequestToWithdrawRequestChain,
         sender: str,
-        receiver: 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.TransactionResponse:
-        r"""Withdraw USDe
+    ) -> models.EthenaRequestToWithdrawTransactionResponse:
+        r"""Request to Withdraw USDe
 
-        Withdraw deposited USDe from Ethena's vault and cease earning passive yield.
+        Request to withdraw deposited USDe from Ethena's vault.
 
-        The passive yield earned on USDe deposits is represented by the increased value of
-        the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
-        for the intial USDe deposited and any accrued yield since depositing.
-        <Info>
-        **Required Allowances**
+        The Ethena vault requires a cooldown period. Once a request to withdraw a specified
+        amount of USDe has been submitted, the alloted cooldown period must pass before the
+        withdraw USDe transaction can be submitted.
 
-        In order to make this transaction, token allowances need to be set for the following contracts.
+        If an additional amount of USDe is requested to be withdrawn anytime before
+        withdrawing the originally requested amount, the cooldown period restarts.
 
-        - `EthenaVault`
-        </Info>
+        Yield is not earned on USDe while in its cooldown period.
 
+        An allowance does not have to be set to initiate the cooldown period.
 
-        :param amount: The amount of USDe to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be withdrawn.
+        :param amount: The amount of USDe to request to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be requested to be withdrawn.
         :param chain:
         :param sender: The address of the transaction sender.
-        :param receiver: The address which will receive the USDe withdrawn. Defaults to the 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
@@ -585,16 +580,15 @@ class Ethena(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.EthenaWithdrawRequest(
+        request = models.EthenaRequestToWithdrawRequest(
             amount=amount,
-            receiver=receiver,
             chain=chain,
             sender=sender,
         )
 
         req = self._build_request_async(
             method="POST",
-            path="/v1/ethena/withdraw",
+            path="/v1/ethena/request",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -606,7 +600,7 @@ class Ethena(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.EthenaWithdrawRequest
+                request, False, False, "json", models.EthenaRequestToWithdrawRequest
             ),
             timeout_ms=timeout_ms,
         )
@@ -623,7 +617,7 @@ class Ethena(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="v1_ethena_withdraw",
+                operation_id="v1_ethena_request",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -634,7 +628,9 @@ class Ethena(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TransactionResponse, http_res)
+            return unmarshal_json_response(
+                models.EthenaRequestToWithdrawTransactionResponse, http_res
+            )
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -649,41 +645,37 @@ class Ethena(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def ethena_request(
+    def ethena_unstake(
         self,
         *,
-        amount: Any,
-        chain: models.EthenaRequestToWithdrawRequestChain,
+        chain: models.EthenaUnstakeRequestChain,
         sender: str,
+        receiver: 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.EthenaRequestToWithdrawTransactionResponse:
-        r"""Request to Withdraw USDe
+    ) -> models.TransactionResponse:
+        r"""Unstake USDe
 
-        Request to withdraw deposited USDe from Ethena's vault.
+        Unstake deposited USDe from Ethena's vault.
 
-        The Ethena vault requires a cooldown period. Once a request to withdraw a specified
-        amount of USDe has been submitted, the alloted cooldown period must pass before the
-        withdraw USDe transaction can be submitted.
+        Verify that the USDe being unstaked has completed its mandatory cooldown period
+        using the Ethena 'Get Vault & User Position' endpoint.
 
-        If an additional amount of USDe is requested to be withdrawn anytime before
-        withdrawing the originally requested amount, the cooldown period restarts.
+        This is an all or nothing action. All of the USDe that has completed its cooldown
+        period must be withdrawn.
 
-        Yield is not earned on USDe while in its cooldown period.
-        <Info>
-        **Required Allowances**
-
-        In order to make this transaction, token allowances need to be set for the following contracts.
-
-        - `EthenaVault`
-        </Info>
+        The passive yield earned on USDe deposits is represented by the increased value of
+        the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
+        for the intial USDe deposited and any accrued yield since depositing.
 
+        An allowance does not have to be set to unstake USDe that has completed its cooldown
+        period.
 
-        :param amount: The amount of USDe to request to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be requested to be withdrawn.
         :param chain:
         :param sender: The address of the transaction sender.
+        :param receiver: The address which will receive the unstaked USDe. Defaults to the 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
@@ -699,15 +691,15 @@ class Ethena(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.EthenaRequestToWithdrawRequest(
-            amount=amount,
+        request = models.EthenaUnstakeRequest(
+            receiver=receiver,
             chain=chain,
             sender=sender,
         )
 
         req = self._build_request(
             method="POST",
-            path="/v1/ethena/request",
+            path="/v1/ethena/unstake",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -719,7 +711,7 @@ class Ethena(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.EthenaRequestToWithdrawRequest
+                request, False, False, "json", models.EthenaUnstakeRequest
             ),
             timeout_ms=timeout_ms,
         )
@@ -736,7 +728,7 @@ class Ethena(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="v1_ethena_request",
+                operation_id="v1_ethena_unstake",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -747,9 +739,7 @@ class Ethena(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.EthenaRequestToWithdrawTransactionResponse, http_res
-            )
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -764,41 +754,37 @@ class Ethena(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def ethena_request_async(
+    async def ethena_unstake_async(
         self,
         *,
-        amount: Any,
-        chain: models.EthenaRequestToWithdrawRequestChain,
+        chain: models.EthenaUnstakeRequestChain,
         sender: str,
+        receiver: 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.EthenaRequestToWithdrawTransactionResponse:
-        r"""Request to Withdraw USDe
-
-        Request to withdraw deposited USDe from Ethena's vault.
-
-        The Ethena vault requires a cooldown period. Once a request to withdraw a specified
-        amount of USDe has been submitted, the alloted cooldown period must pass before the
-        withdraw USDe transaction can be submitted.
+    ) -> models.TransactionResponse:
+        r"""Unstake USDe
 
-        If an additional amount of USDe is requested to be withdrawn anytime before
-        withdrawing the originally requested amount, the cooldown period restarts.
+        Unstake deposited USDe from Ethena's vault.
 
-        Yield is not earned on USDe while in its cooldown period.
-        <Info>
-        **Required Allowances**
+        Verify that the USDe being unstaked has completed its mandatory cooldown period
+        using the Ethena 'Get Vault & User Position' endpoint.
 
-        In order to make this transaction, token allowances need to be set for the following contracts.
+        This is an all or nothing action. All of the USDe that has completed its cooldown
+        period must be withdrawn.
 
-        - `EthenaVault`
-        </Info>
+        The passive yield earned on USDe deposits is represented by the increased value of
+        the shares received (sUSDe) upon depositing USDe. Trade in these shares in exchange
+        for the intial USDe deposited and any accrued yield since depositing.
 
+        An allowance does not have to be set to unstake USDe that has completed its cooldown
+        period.
 
-        :param amount: The amount of USDe to request to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be requested to be withdrawn.
         :param chain:
         :param sender: The address of the transaction sender.
+        :param receiver: The address which will receive the unstaked USDe. Defaults to the 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
@@ -814,15 +800,15 @@ class Ethena(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.EthenaRequestToWithdrawRequest(
-            amount=amount,
+        request = models.EthenaUnstakeRequest(
+            receiver=receiver,
             chain=chain,
             sender=sender,
         )
 
         req = self._build_request_async(
             method="POST",
-            path="/v1/ethena/request",
+            path="/v1/ethena/unstake",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -834,7 +820,7 @@ class Ethena(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.EthenaRequestToWithdrawRequest
+                request, False, False, "json", models.EthenaUnstakeRequest
             ),
             timeout_ms=timeout_ms,
         )
@@ -851,7 +837,7 @@ class Ethena(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="v1_ethena_request",
+                operation_id="v1_ethena_unstake",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -862,9 +848,7 @@ class Ethena(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(
-                models.EthenaRequestToWithdrawTransactionResponse, http_res
-            )
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res

{compass_api_sdk-1.0.1 → compass_api_sdk-1.1.0}/src/compass_api_sdk/models/__init__.py

@@ -335,14 +335,11 @@ if TYPE_CHECKING:
         EthenaRequestToWithdrawTransactionResponseTransactionTypedDict,
         EthenaRequestToWithdrawTransactionResponseTypedDict,
     )
-    from .ethenawithdrawparams import (
-        EthenaWithdrawParams,
-        EthenaWithdrawParamsTypedDict,
-    )
-    from .ethenawithdrawrequest import (
-        EthenaWithdrawRequest,
-        EthenaWithdrawRequestChain,
-        EthenaWithdrawRequestTypedDict,
+    from .ethenaunstakeparams import EthenaUnstakeParams, EthenaUnstakeParamsTypedDict
+    from .ethenaunstakerequest import (
+        EthenaUnstakeRequest,
+        EthenaUnstakeRequestChain,
+        EthenaUnstakeRequestTypedDict,
     )
     from .feeenum import FeeEnum
     from .interestratemode import InterestRateMode
@@ -1372,11 +1369,11 @@ __all__ = [
     "EthenaRequestToWithdrawTransactionResponseTransaction",
     "EthenaRequestToWithdrawTransactionResponseTransactionTypedDict",
     "EthenaRequestToWithdrawTransactionResponseTypedDict",
-    "EthenaWithdrawParams",
-    "EthenaWithdrawParamsTypedDict",
-    "EthenaWithdrawRequest",
-    "EthenaWithdrawRequestChain",
-    "EthenaWithdrawRequestTypedDict",
+    "EthenaUnstakeParams",
+    "EthenaUnstakeParamsTypedDict",
+    "EthenaUnstakeRequest",
+    "EthenaUnstakeRequestChain",
+    "EthenaUnstakeRequestTypedDict",
     "FeeEnum",
     "InitialCollateralAmount",
     "InitialCollateralAmountTypedDict",
@@ -2207,11 +2204,11 @@ _dynamic_imports: dict[str, str] = {
     "EthenaRequestToWithdrawTransactionResponseTransaction": ".ethenarequesttowithdrawtransactionresponse",
     "EthenaRequestToWithdrawTransactionResponseTransactionTypedDict": ".ethenarequesttowithdrawtransactionresponse",
     "EthenaRequestToWithdrawTransactionResponseTypedDict": ".ethenarequesttowithdrawtransactionresponse",
-    "EthenaWithdrawParams": ".ethenawithdrawparams",
-    "EthenaWithdrawParamsTypedDict": ".ethenawithdrawparams",
-    "EthenaWithdrawRequest": ".ethenawithdrawrequest",
-    "EthenaWithdrawRequestChain": ".ethenawithdrawrequest",
-    "EthenaWithdrawRequestTypedDict": ".ethenawithdrawrequest",
+    "EthenaUnstakeParams": ".ethenaunstakeparams",
+    "EthenaUnstakeParamsTypedDict": ".ethenaunstakeparams",
+    "EthenaUnstakeRequest": ".ethenaunstakerequest",
+    "EthenaUnstakeRequestChain": ".ethenaunstakerequest",
+    "EthenaUnstakeRequestTypedDict": ".ethenaunstakerequest",
     "FeeEnum": ".feeenum",
     "InterestRateMode": ".interestratemode",
     "LiquidationCall": ".liquidationcall",

compass_api_sdk-1.1.0/src/compass_api_sdk/models/ethenaunstakeparams.py

@@ -0,0 +1,65 @@
+"""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 validate_const
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import AfterValidator
+from typing import Literal, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class EthenaUnstakeParamsTypedDict(TypedDict):
+    action_type: Literal["ETHENA_UNSTAKE"]
+    receiver: NotRequired[Nullable[str]]
+    r"""The address which will receive the unstaked USDe. Defaults to the sender."""
+
+
+class EthenaUnstakeParams(BaseModel):
+    ACTION_TYPE: Annotated[
+        Annotated[
+            Optional[Literal["ETHENA_UNSTAKE"]],
+            AfterValidator(validate_const("ETHENA_UNSTAKE")),
+        ],
+        pydantic.Field(alias="action_type"),
+    ] = "ETHENA_UNSTAKE"
+
+    receiver: OptionalNullable[str] = UNSET
+    r"""The address which will receive the unstaked USDe. Defaults to the sender."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["action_type", "receiver"]
+        nullable_fields = ["receiver"]
+        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-1.0.1/src/compass_api_sdk/models/ethenawithdrawparams.py → compass_api_sdk-1.1.0/src/compass_api_sdk/models/ethenaunstakerequest.py

@@ -9,35 +9,43 @@ from compass_api_sdk.types import (
     UNSET_SENTINEL,
 )
 from compass_api_sdk.utils import validate_const
+from enum import Enum
 import pydantic
 from pydantic import model_serializer
 from pydantic.functional_validators import AfterValidator
-from typing import Any, Literal, Optional
+from typing import Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class EthenaWithdrawParamsTypedDict(TypedDict):
-    amount: Any
-    r"""The amount of USDe to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be withdrawn."""
-    action_type: Literal["ETHENA_WITHDRAW"]
+class EthenaUnstakeRequestChain(str, Enum):
+    ETHEREUM = "ethereum"
+
+
+class EthenaUnstakeRequestTypedDict(TypedDict):
+    chain: EthenaUnstakeRequestChain
+    sender: str
+    r"""The address of the transaction sender."""
+    action_type: Literal["ETHENA_UNSTAKE"]
     receiver: NotRequired[Nullable[str]]
-    r"""The address which will receive the USDe withdrawn. Defaults to the sender."""
+    r"""The address which will receive the unstaked USDe. Defaults to the sender."""
+
 
+class EthenaUnstakeRequest(BaseModel):
+    chain: EthenaUnstakeRequestChain
 
-class EthenaWithdrawParams(BaseModel):
-    amount: Any
-    r"""The amount of USDe to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be withdrawn."""
+    sender: str
+    r"""The address of the transaction sender."""
 
     ACTION_TYPE: Annotated[
         Annotated[
-            Optional[Literal["ETHENA_WITHDRAW"]],
-            AfterValidator(validate_const("ETHENA_WITHDRAW")),
+            Optional[Literal["ETHENA_UNSTAKE"]],
+            AfterValidator(validate_const("ETHENA_UNSTAKE")),
         ],
         pydantic.Field(alias="action_type"),
-    ] = "ETHENA_WITHDRAW"
+    ] = "ETHENA_UNSTAKE"
 
     receiver: OptionalNullable[str] = UNSET
-    r"""The address which will receive the USDe withdrawn. Defaults to the sender."""
+    r"""The address which will receive the unstaked USDe. Defaults to the sender."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):