Support for Portfolios Endpoints (#49)

* list portfolios

* supporting create_portfolio endpoint

* edit_portfolio endpoint support

* delete_portfolio endpoint

* get_portfolio_breakdown

* move funds

* modernizing python code

Author: KmiQ

coinbaseadvanced/client.py

@@ -4,28 +4,13 @@
 
 from uuid import UUID
 from datetime import datetime
-from typing import List
+from typing import List, Optional
 import requests
 
-from coinbaseadvanced.models.common import BaseModel
+from coinbaseadvanced.models.common import BaseModel, ValueCurrency
 from coinbaseadvanced.models.error import CoinbaseAdvancedTradeAPIError
 
 
-class AvailableBalance(BaseModel):
-    """
-    Available Balance object.
-    """
-
-    value: str
-    currency: str
-
-    def __init__(self, value: str, currency: str, **kwargs) -> None:
-        self.value = value
-        self.currency = currency
-
-        self.kwargs = kwargs
-
-
 class Account(BaseModel):
     """
     Object representing an account.
@@ -34,15 +19,15 @@ class Account(BaseModel):
     uuid: UUID
     name: str
     currency: str
-    available_balance: AvailableBalance
+    available_balance: Optional[ValueCurrency]
     default: bool
     active: bool
     created_at: datetime
     updated_at: datetime
     deleted_at: datetime
     type: str
     ready: bool
-    hold: AvailableBalance
+    hold: Optional[ValueCurrency]
 
     def __init__(
         self, uuid: UUID, name: str, currency: str, available_balance: dict, default: bool,
@@ -51,7 +36,7 @@ def __init__(
         self.uuid = uuid
         self.name = name
         self.currency = currency
-        self.available_balance = AvailableBalance(**available_balance) \
+        self.available_balance = ValueCurrency(**available_balance) \
             if available_balance is not None else None
         self.default = default
         self.active = active
@@ -60,7 +45,7 @@ def __init__(
         self.deleted_at = deleted_at
         self.type = type
         self.ready = ready
-        self.hold = AvailableBalance(**hold) if hold is not None else None
+        self.hold = ValueCurrency(**hold) if hold is not None else None
 
         self.kwargs = kwargs
 
@@ -85,19 +70,19 @@ class AccountsPage(BaseModel):
 
     accounts: List[Account]
     has_next: bool
-    cursor: str
+    cursor: Optional[str]
     size: int
 
     def __init__(self,
                  accounts: List[dict],
                  has_next: bool,
-                 cursor: str,
+                 cursor: Optional[str],
                  size: int,
                  **kwargs
                  ) -> None:
 
         self.accounts = list(map(lambda x: Account(**x), accounts))\
-            if accounts is not None else None
+            if accounts is not None else []
 
         self.has_next = has_next
         self.cursor = cursor
@@ -118,4 +103,4 @@ def from_response(cls, response: requests.Response) -> 'AccountsPage':
         return cls(**result)
 
     def __iter__(self):
-        return self.accounts.__iter__()
+        return self.accounts.__iter__() if self.accounts is not None else [].__iter__()

coinbaseadvanced/models/accounts.py

@@ -2,22 +2,63 @@
 Object models for order related endpoints args and response.
 """
 
-from coinbaseadvanced.models.error import CoinbaseAdvancedTradeAPIError
-
 import requests
 
+from coinbaseadvanced.models.error import CoinbaseAdvancedTradeAPIError
+
 
 class BaseModel:
+    """
+    Base class for models.
+    """
 
     def __str__(self):
-        attributes = ", ".join(f"{key}={value}" for key, value in self.__dict__.items())
+        attributes = ", ".join(
+            f"{key}={value}" for key, value in self.__dict__.items())
         return f"{self.__class__.__name__}({attributes})"
 
     def __repr__(self):
-        attributes = ", ".join(f"{key}={value!r}" for key, value in self.__dict__.items())
+        attributes = ", ".join(
+            f"{key}={value!r}" for key, value in self.__dict__.items())
         return f"{self.__class__.__name__}({attributes})"
 
 
+class EmptyResponse(BaseModel):
+    """
+    Represents an empty response from the Coinbase Advanced Trade API.
+
+    Attributes:
+        success (bool): Indicates whether the response was successful or not.
+    """
+
+    success: bool
+
+    def __init__(self, **kwargs) -> None:
+        self.success = True
+        self.kwargs = kwargs
+
+    @classmethod
+    def from_response(cls, response: requests.Response) -> 'EmptyResponse':
+        """
+        Factory Method that creates an EmptyResponse object from a requests.Response object.
+
+        Args:
+            response (requests.Response): The response object returned by the API.
+
+        Returns:
+            EmptyResponse: An instance of the EmptyResponse class.
+
+        Raises:
+            CoinbaseAdvancedTradeAPIError: If the response is not OK.
+        """
+
+        if not response.ok:
+            raise CoinbaseAdvancedTradeAPIError.not_ok_response(response)
+
+        result = response.json()
+        return cls(**result)
+
+
 class UnixTime(BaseModel):
     """
     Unix time in different formats.
@@ -51,3 +92,18 @@ def from_response(cls, response: requests.Response) -> 'UnixTime':
 
         result = response.json()
         return cls(**result)
+
+
+class ValueCurrency(BaseModel):
+    """
+    Available Balance object.
+    """
+
+    value: str
+    currency: str
+
+    def __init__(self, value: str, currency: str, **kwargs) -> None:
+        self.value = value
+        self.currency = currency
+
+        self.kwargs = kwargs

coinbaseadvanced/models/common.py

@@ -26,7 +26,7 @@ def not_ok_response(cls, response: requests.Response) -> 'CoinbaseAdvancedTradeA
 
         try:
             error_result = json.loads(response.text)
-        except ValueError as error:
+        except ValueError:
             error_result = {'reason': response.text}
 
         return cls(error_dict=error_result)

coinbaseadvanced/models/error.py

@@ -2,6 +2,7 @@
 Object models for fees related endpoints args and response.
 """
 
+from typing import Optional
 import requests
 
 from coinbaseadvanced.models.common import BaseModel
@@ -69,23 +70,33 @@ class TransactionsSummary(BaseModel):
 
     total_volume: int
     total_fees: int
-    fee_tier: FeeTier
-    margin_rate: MarginRate
-    goods_and_services_tax: GoodsAndServicesTax
+    fee_tier: Optional[FeeTier]
+    margin_rate: Optional[MarginRate]
+    goods_and_services_tax: Optional[GoodsAndServicesTax]
     advanced_trade_only_volume: int
     advanced_trade_only_fees: int
     coinbase_pro_volume: int
     coinbase_pro_fees: int
     total_balance: str
     has_promo_fee: bool
 
-    def __init__(self, total_volume: int, total_fees: int, fee_tier: dict, margin_rate: dict,
-                 goods_and_services_tax: dict, advanced_trade_only_volume: int, advanced_trade_only_fees: int,
-                 coinbase_pro_volume: int, coinbase_pro_fees: int, total_balance: str, has_promo_fee: bool, **kwargs) -> None:
+    def __init__(self,
+                 total_volume: int,
+                 total_fees: int,
+                 fee_tier: dict,
+                 margin_rate: dict,
+                 goods_and_services_tax: dict,
+                 advanced_trade_only_volume: int,
+                 advanced_trade_only_fees: int,
+                 coinbase_pro_volume: int,
+                 coinbase_pro_fees: int,
+                 total_balance: str,
+                 has_promo_fee: bool, **kwargs) -> None:
         self.total_volume = total_volume
         self.total_fees = total_fees
         self.fee_tier = FeeTier(**fee_tier) if fee_tier is not None else None
-        self.margin_rate = MarginRate(**margin_rate) if margin_rate is not None else None
+        self.margin_rate = MarginRate(
+            **margin_rate) if margin_rate is not None else None
         self.goods_and_services_tax = GoodsAndServicesTax(
             **goods_and_services_tax) if goods_and_services_tax is not None else None
         self.advanced_trade_only_volume = advanced_trade_only_volume

coinbaseadvanced/models/fees.py

@@ -0,0 +1,77 @@
+"""
+This module contains the definition of the FuturesPosition class and related enums.
+"""
+
+from enum import Enum
+from coinbaseadvanced.models.common import BaseModel
+
+
+class MarginType(Enum):
+    """
+    Enum representing the margin type for futures trading.
+    """
+
+    UNSPECIFIED = "MARGIN_TYPE_UNSPECIFIED"
+    CROSS = "MARGIN_TYPE_CROSS"
+    ISOLATED = "MARGIN_TYPE_ISOLATED"
+
+
+class FuturesPositionSide(Enum):
+    """
+    Enum representing the position side for futures contracts.
+    """
+
+    UNSPECIFIED = "FUTURES_POSITION_SIDE_UNSPECIFIED"
+    LONG = "FUTURES_POSITION_SIDE_LONG"
+    SHORT = "FUTURES_POSITION_SIDE_SHORT"
+
+
+class FuturesPosition(BaseModel):
+    """
+    Represents a futures position.
+
+    Attributes:
+        product_id (str): The ID of the product.
+        contract_size (str): The size of the contract.
+        side (FuturesPositionSide): The side of the position.
+        amount (str): The amount of the position.
+        avg_entry_price (str): The average entry price of the position.
+        current_price (str): The current price of the position.
+        unrealized_pnl (str): The unrealized profit/loss of the position.
+        expiry (str): The expiry date of the position.
+        underlying_asset (str): The underlying asset of the position.
+        asset_img_url (str): The URL of the asset's image.
+        product_name (str): The name of the product.
+        venue (str): The venue of the position.
+        notional_value (str): The notional value of the position.
+    """
+
+    def __init__(
+            self, product_id: str,
+            contract_size: str,
+            side: str,
+            amount: str,
+            avg_entry_price: str,
+            current_price: str,
+            unrealized_pnl: str,
+            expiry: str,
+            underlying_asset: str,
+            asset_img_url: str,
+            product_name: str,
+            venue: str,
+            notional_value: str, **kwargs) -> None:
+        self.product_id = product_id
+        self.contract_size = contract_size
+        self.side = FuturesPositionSide[side]
+        self.amount = amount
+        self.avg_entry_price = avg_entry_price
+        self.current_price = current_price
+        self.unrealized_pnl = unrealized_pnl
+        self.expiry = expiry
+        self.underlying_asset = underlying_asset
+        self.asset_img_url = asset_img_url
+        self.product_name = product_name
+        self.venue = venue
+        self.notional_value = notional_value
+
+        self.kwargs = kwargs