Implemented edit_order endpoint (#54)

Author: jonandtice

coinbaseadvanced/client.py

@@ -21,7 +21,7 @@
 from coinbaseadvanced.models.products import BidAsksPage, ProductBook, ProductsPage, Product, \
     CandlesPage, TradesPage, ProductType, Granularity, GRANULARITY_MAP_IN_MINUTES
 from coinbaseadvanced.models.accounts import AccountsPage, Account
-from coinbaseadvanced.models.orders import OrderPlacementSource, OrdersPage, Order, \
+from coinbaseadvanced.models.orders import OrderPlacementSource, OrdersPage, Order, OrderEdit, \
     OrderBatchCancellation, FillsPage, Side, StopDirection, OrderType
 
 
@@ -331,6 +331,37 @@ def create_order(self, client_order_id: str,
         order = Order.from_create_order_response(response)
         return order
 
+    def edit_order(self, order_id: str, limit_price: float, base_size: float) -> OrderEdit:
+        """
+        https://docs.cloud.coinbase.com/advanced-trade-api/reference/retailbrokerageapi_editorder
+
+        Edit an order's size (quantity), or price. Only good-till-cancelled (GTC) Limit Orders can be edited.
+
+        Args:
+        - order_id: ID of order to edit.
+        - limit_price: New price for order.
+        - base_size: New size for order
+        """
+
+        request_path = f"/api/v3/brokerage/orders/edit"
+        method = "POST"
+
+        payload = {
+            'order_id': order_id,
+            'price': str(limit_price),
+            'size': str(base_size)
+        }
+
+        headers = self._build_request_headers(method, request_path, json.dumps(payload)) \
+            if self._is_legacy_auth() \
+            else self._build_request_headers_for_cloud(method, self._host, request_path)
+        response = requests.post(self._base_url+request_path,
+                                 json=payload, headers=headers,
+                                 timeout=self.timeout)
+
+        edit_result = OrderEdit.from_get_edit_response(response)
+        return edit_result
+
     def cancel_orders(self, order_ids: list) -> OrderBatchCancellation:
         """
         https://docs.cloud.coinbase.com/advanced-trade-api/reference/retailbrokerageapi_cancelorders

coinbaseadvanced/models/orders.py

@@ -444,6 +444,35 @@ def __iter__(self):
         return self.orders.__iter__()
 
 
+class OrderEdit(BaseModel):
+    """
+    Order edit.
+    """
+
+    success: bool
+    errors: List[dict]
+    edit_failure_reason: str
+    preview_failure_reason: str
+
+    def __init__(self, success: bool, errors: List[dict], **kwargs) -> None:
+        self.success = success
+        self.errors = errors if errors is not None else None
+
+        self.kwargs = kwargs
+    
+    @classmethod
+    def from_get_edit_response(cls, response: requests.Response) -> 'OrderEdit':
+        """
+        Factory Method.
+        """
+
+        if not response.ok:
+            raise CoinbaseAdvancedTradeAPIError.not_ok_response(response)
+
+        result = response.json()
+        return cls(**result)
+
+
 class OrderCancellation(BaseModel):
     """
     Order cancellation.