Resolve "Add the /0/private/AmendOrder and /0/private/OrderAmends endpoints" (#362)

Author: btschwertfeger

src/kraken/spot/funding.py

@@ -249,6 +249,90 @@ def get_recent_deposits_status(
             extra_params=extra_params,
         )
 
+    def withdraw_methods(
+        self: Funding,
+        asset: str | None = None,
+        aclass: str | None = None,
+        network: str | None = None,
+        *,
+        extra_params: dict | None = None,
+    ) -> dict:
+        """
+        Returns the list of available withdraw methods for that user.
+
+        Requires the ``Funds permissions - Query`` and ``Funds permissions -
+        Withdraw`` API key permissions.
+
+        :param asset: Filter by asset
+        :type asset: Optional[str]
+        :param aclass: Filter by asset class (default: ``currency``)
+        :type aclass: Optional[str]
+        :param network: Filter by network
+        :type network: Optional[str]
+        :return: List of available withdraw methods
+        :rtype: list[dict]
+        """
+        params: dict = {}
+        if defined(asset):
+            params["asset"] = asset
+        if defined(aclass):
+            params["network"] = aclass
+        if defined(network):
+            params["network"] = network
+        return self.request(  # type: ignore[return-value]
+            method="POST",
+            uri="/0/private/WithdrawMethods",
+            params=params,
+            extra_params=extra_params,
+        )
+
+    def withdraw_addresses(
+        self: Funding,
+        asset: str | None = None,
+        aclass: str | None = None,
+        method: str | None = None,
+        key: str | None = None,
+        verified: bool | None = None,  # noqa: FBT001
+        *,
+        extra_params: dict | None = None,
+    ) -> dict:
+        """
+        Returns the list of available withdrawal addresses for that user.
+
+        Requires the ``Funds permissions - Query`` and ``Funds permissions -
+        Withdraw`` API key permissions.
+
+        :param asset: Filter by asset
+        :type asset: Optional[str]
+        :param aclass: Filter by asset class (default: ``currency``)
+        :type aclass: Optional[str]
+        :param method: Filter by method
+        :type method: Optional[str]
+        :param key: Filter by key
+        :type key: Optional[str]
+        :param verified: List only addresses which are confirmed via E-Mail
+        :type verified: Optional[str]
+        :return: List of available addresses for withdrawal
+        :rtype: list[dict]
+        """
+        params: dict = {}
+        if defined(asset):
+            params["asset"] = asset
+        if defined(aclass):
+            params["network"] = aclass
+        if defined(method):
+            params["method"] = method
+        if defined(key):
+            params["key"] = key
+        if defined(verified):
+            params["verified"] = verified
+        return self.request(  # type: ignore[return-value]
+            method="POST",
+            uri="/0/private/WithdrawMethods",
+            params=params,
+            extra_params=extra_params,
+        )
+
     def get_withdrawal_info(
         self: Funding,
         asset: str,
@@ -510,89 +594,5 @@ def wallet_transfer(
             extra_params=extra_params,
         )
 
-    def withdraw_methods(
-        self: Funding,
-        asset: str | None = None,
-        aclass: str | None = None,
-        network: str | None = None,
-        *,
-        extra_params: dict | None = None,
-    ) -> dict:
-        """
-        Returns the list of available withdraw methods for that user.
-
-        Requires the ``Funds permissions - Query`` and ``Funds permissions -
-        Withdraw`` API key permissions.
-
-        :param asset: Filter by asset
-        :type asset: Optional[str]
-        :param aclass: Filter by asset class (default: ``currency``)
-        :type aclass: Optional[str]
-        :param network: Filter by network
-        :type network: Optional[str]
-        :return: List of available withdraw methods
-        :rtype: list[dict]
-        """
-        params: dict = {}
-        if defined(asset):
-            params["asset"] = asset
-        if defined(aclass):
-            params["network"] = aclass
-        if defined(network):
-            params["network"] = network
-        return self.request(  # type: ignore[return-value]
-            method="POST",
-            uri="/0/private/WithdrawMethods",
-            params=params,
-            extra_params=extra_params,
-        )
-
-    def withdraw_addresses(
-        self: Funding,
-        asset: str | None = None,
-        aclass: str | None = None,
-        method: str | None = None,
-        key: str | None = None,
-        verified: bool | None = None,  # noqa: FBT001
-        *,
-        extra_params: dict | None = None,
-    ) -> dict:
-        """
-        Returns the list of available withdrawal addresses for that user.
-
-        Requires the ``Funds permissions - Query`` and ``Funds permissions -
-        Withdraw`` API key permissions.
-
-        :param asset: Filter by asset
-        :type asset: Optional[str]
-        :param aclass: Filter by asset class (default: ``currency``)
-        :type aclass: Optional[str]
-        :param method: Filter by method
-        :type method: Optional[str]
-        :param key: Filter by key
-        :type key: Optional[str]
-        :param verified: List only addresses which are confirmed via E-Mail
-        :type verified: Optional[str]
-        :return: List of available addresses for withdrawal
-        :rtype: list[dict]
-        """
-        params: dict = {}
-        if defined(asset):
-            params["asset"] = asset
-        if defined(aclass):
-            params["network"] = aclass
-        if defined(method):
-            params["method"] = method
-        if defined(key):
-            params["key"] = key
-        if defined(verified):
-            params["verified"] = verified
-        return self.request(  # type: ignore[return-value]
-            method="POST",
-            uri="/0/private/WithdrawMethods",
-            params=params,
-            extra_params=extra_params,
-        )
-
 
 __all__ = ["Funding"]

src/kraken/spot/trade.py

@@ -470,6 +470,38 @@ def create_order_batch(
             extra_params=extra_params,
         )
 
+    def amend_order(
+        self: Trade,
+        *,
+        extra_params: dict | None = None,
+    ) -> dict:
+        """
+        Amend/modify an open order.
+
+        Requires the ``Create and modify orders`` and ``Cancel & close orders``
+        permissions in the API key settings.
+
+        - https://docs.kraken.com/api/docs/rest-api/amend-order
+
+        .. code-block:: python
+            :linenos:
+            :caption: Spot Trade: Amend order
+
+            >>> from kraken.spot import Trade
+            >>> trade = Trade(key="api-key", secret="secret-key")
+            >>> trade.amend_order(
+            ...     extra_params={
+            ...         "txid": "OVM3PT-56ACO-53SM2T",
+            ...         "limit_price": "105636.9",
+            ...     }
+            ... )
+        """
+        return self.request(  # type: ignore[return-value]
+            "POST",
+            uri="/0/private/AmendOrder",
+            extra_params=extra_params,
+        )
+
     @ensure_string("oflags")
     def edit_order(  # pylint: disable=too-many-arguments # noqa: PLR0913, PLR0917
         self: Trade,
@@ -490,8 +522,8 @@ def edit_order(  # pylint: disable=too-many-arguments # noqa: PLR0913, PLR0917
         """
         Edit an open order.
 
-        Requires the ``Create and modify orders`` permission in
-        the API key settings.
+        Requires the ``Create and modify orders`` permission in the API key
+        settings.
 
         - https://docs.kraken.com/api/docs/rest-api/edit-order
 

src/kraken/spot/user.py

@@ -113,6 +113,8 @@ def get_balances(
 
         Requires the ``Query funds`` permission in the API key settings.
 
+        - https://docs.kraken.com/api/docs/rest-api/get-extended-balance
+
         :return: Dictionary containing the ``currency`` as keys, that hold a
             dictionary containing the ``balance`` key holding the actual balance
             including the value in orders and the ``hold_trade`` key that
@@ -520,6 +522,42 @@ def get_orders_info(
             extra_params=extra_params,
         )
 
+    def get_order_amends(
+        self: User,
+        order_id: str,
+        *,
+        extra_params: dict | None = None,
+    ) -> dict:
+        """
+        Retrieve information about historical order amends.
+
+        Requires the ``Query open orders & trades`` and ``Query closed orders &
+        trades`` permissions in the API key settings.
+
+        - https://docs.kraken.com/api/docs/rest-api/get-order-amends
+
+        :param order_id: The ``order_id`` to filter for.
+        :type txid: str
+
+        .. code-block:: python
+            :linenos:
+            :caption: Spot User: Get order amends
+
+            >>> from kraken.spot import User
+            >>> user = User(key="api-key", secret="secret-key")
+            >>> user.get_order_amends(txid="OVM3PT-56ACO-53SM2T")
+            {'amends': [], 'count': 0}
+        """
+        params = {}
+        if defined(order_id):
+            params["order_id"] = order_id
+        return self.request(  # type: ignore[return-value]
+            method="POST",
+            uri="/0/private/OrderAmends",
+            params=params,
+            extra_params=extra_params,
+        )
+
     def get_trades_history(  # pylint: disable=too-many-arguments
         self: User,
         type_: str | None = "all",

tests/spot/test_spot_trade.py

@@ -190,6 +190,25 @@ def test_edit_order(spot_auth_trade: Trade) -> None:
         )
 
 
+@pytest.mark.spot
+@pytest.mark.spot_auth
+@pytest.mark.spot_trade
+def test_amend_order(spot_auth_trade: Trade) -> None:
+    """
+    Test the ``amend_order`` function by editing an order.
+
+    KrakenPermissionDeniedError: since CI does not have trade permissions. If
+    the request would be malformed, another exception could be observed.
+    """
+    with pytest.raises(KrakenPermissionDeniedError):
+        spot_auth_trade.amend_order(
+            extra_params={
+                "txid": "OVM3PT-56ACO-53SM2T",
+                "limit_price": "105636.9",
+            },
+        )
+
+
 @pytest.mark.spot
 @pytest.mark.spot_auth
 @pytest.mark.spot_trade

tests/spot/test_spot_user.py

@@ -198,6 +198,18 @@ def test_get_orders_info(spot_auth_user: User) -> None:
             sleep(2)
 
 
+@pytest.mark.spot
+@pytest.mark.spot_auth
+@pytest.mark.spot_user
+def test_get_order_amends(spot_auth_user: User) -> None:
+    """
+    Checks the ``get_order_amends`` function by validating that the responses do
+    not contain the error key.
+    """
+
+    assert is_not_error(spot_auth_user.get_order_amends(order_id="OVM3PT-56ACO-53SM2T"))
+
+
 @pytest.mark.spot
 @pytest.mark.spot_auth
 @pytest.mark.spot_user