SP-738 Type Review: Python

Author: mwarzybok-sumoheavy

src/bitpay/clients/bitpay_client.py

@@ -1,5 +1,6 @@
 import json
 import urllib
+from datetime import datetime, timezone
 from typing import Dict, Any, Optional
 
 import requests
@@ -50,7 +51,7 @@ def post(
         :raises BitPayApiException
         """
         full_url = self.__base_url + uri
-        form_data = json.dumps(form_data)
+        form_data = json.dumps(form_data, default=json_serialize)
         if signature_required:
             self.__headers["x-signature"] = sign(full_url + form_data, self.__ec_key)
             self.__headers["x-identity"] = get_compressed_public_key_from_pem(
@@ -117,9 +118,15 @@ def update(self, uri: str, form_data: Any = {}) -> Response:
         """
 
         full_url = self.__base_url + uri
-        form_data = json.dumps(form_data)
+        form_data = json.dumps(form_data, default=json_serialize)
 
         self.__headers["x-signature"] = sign(full_url + form_data, self.__ec_key)
         self.__headers["x-identity"] = get_compressed_public_key_from_pem(self.__ec_key)
 
         return requests.put(full_url, data=form_data, headers=self.__headers)
+
+
+def json_serialize(obj):
+    if isinstance(obj, datetime):
+        return obj.astimezone(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
+    raise TypeError("Type %s not serializable" % type(obj))

src/bitpay/models/bill/bill.py

@@ -1,6 +1,7 @@
 """
 Bill
 """
+from datetime import datetime
 from typing import List, Union
 from .item import Item
 from ..bitpay_model import BitPayModel
@@ -27,10 +28,10 @@ class Bill(BitPayModel):
     country: Union[str, None] = None
     cc: Union[List[str], None] = None
     phone: Union[str, None] = None
-    due_date: Union[str, None] = None
+    due_date: Union[datetime, None] = None
     pass_processing_fee: bool = False
     status: Union[str, None] = None
     url: Union[str, None] = None
-    created_date: Union[str, None] = None
+    created_date: Union[datetime, None] = None
     id: Union[str, None] = None
     merchant: Union[str, None] = None

src/bitpay/models/bill/bill_status.py

@@ -1,15 +1,16 @@
 """
 BillStatus
 """
+from enum import Enum
 
 
-class BillStatus:
+class BillStatus(Enum):
     """
     Bill Status
     """
 
-    Draft = "draft"
-    Sent = "sent"
-    New = "new"
-    Paid = "paid"
-    Complete = "complete"
+    DRAFT = "draft"
+    SENT = "sent"
+    NEW = "new"
+    PAID = "paid"
+    COMPLETE = "complete"

src/bitpay/models/bitpay_model.py

@@ -2,7 +2,6 @@
 
 from pydantic import BaseModel, field_validator, ConfigDict
 
-from bitpay.exceptions.bitpay_exception import BitPayException
 from bitpay.exceptions.bitpay_exception_provider import BitPayExceptionProvider
 from bitpay.utils.model_util import ModelUtil
 

src/bitpay/models/currency.py

@@ -200,12 +200,16 @@ class Currency(BitPayModel):
     symbol: Union[str, None] = None
     precision: int
     name: str
-    plural: Union[str, None] = None
-    alts: Union[str, None] = None
-    minimum: Union[float, None] = None
+    plural: str
+    alts: str
+    minimum: float
     sanctioned: bool = False
     decimals: int
+    display_code: Union[str, None] = None
     chain: Union[str, None] = None
+    max_supply: Union[float, None] = None
+    tranche_decimals: Union[int, None] = None
+    contract_address: Union[str, None] = None
 
     @classmethod
     def is_valid(cls, value: str) -> bool:

src/bitpay/models/invoice/buyer.py

@@ -20,4 +20,3 @@ class Buyer(BitPayModel):
     email: Union[str, None] = None
     phone: Union[str, None] = None
     notify: bool = False
-    buyer_email: Union[str, None] = None

src/bitpay/models/invoice/buyer_fields.py

@@ -0,0 +1,16 @@
+from typing import Union
+
+from bitpay.models.bitpay_model import BitPayModel
+
+
+class BuyerFields(BitPayModel):
+    buyer_address1: Union[str, None] = None
+    buyer_address2: Union[str, None] = None
+    buyer_city: Union[str, None] = None
+    buyer_country: Union[str, None] = None
+    buyer_email: Union[str, None] = None
+    buyer_name: Union[str, None] = None
+    buyer_notify: bool = False
+    buyer_phone: Union[str, None] = None
+    buyer_state: Union[str, None] = None
+    buyer_zip: Union[str, None] = None

src/bitpay/models/invoice/invoice.py

@@ -1,7 +1,7 @@
 """
 Invoice
 """
-from typing import List, Union
+from typing import List, Union, Dict
 from pydantic import Field
 from .buyer import Buyer
 from .buyer_provided_info import BuyerProvidedInfo
@@ -39,17 +39,17 @@ class Invoice(BitPayModel):
     item_code: Union[str, None] = None
     physical: Union[bool, None] = False
     payment_currencies: Union[List[str], None] = None
-    payment_subtotals: Union[dict, None] = None
-    payment_totals: Union[dict, None] = None
-    payment_display_totals: Union[dict, None] = None
-    payment_display_subtotals: Union[dict, None] = None
-    payment_codes: Union[dict, None] = None
+    payment_subtotals: Union[Dict[str, int], None] = None
+    payment_totals: Union[Dict[str, int], None] = None
+    payment_display_totals: Union[Dict[str, str], None] = None
+    payment_display_subtotals: Union[Dict[str, str], None] = None
+    payment_codes: Union[Dict[str, Dict[str, str]], None] = None
     acceptance_window: Union[int, None] = None
     buyer: Union[Buyer, None] = None
     refund_addresses: Union[List[str], None] = None
     close_url: Union[str, None] = Field(alias="closeURL", default=None)
     auto_redirect: Union[bool, None] = False
-    json_paypro_required: bool = False
+    json_paypro_required: Union[bool, None] = False
     id: Union[str, None] = None
     url: Union[str, None] = None
     status: Union[str, None] = None
@@ -71,16 +71,12 @@ class Invoice(BitPayModel):
     bill_id: Union[str, None] = None
     refund_info: Union[List[RefundInfo], None] = None
     extended_notifications: Union[bool, None] = False
-    invoice_buyer_provided_info: Union[BuyerProvidedInfo, None] = None
     transaction_currency: Union[str, None] = None
     underpaid_amount: Union[float, None] = None
     overpaid_amount: Union[float, None] = None
     amount_paid: Union[float, None] = None
     display_amount_paid: Union[str, None] = None
-    exchange_rates: Union[dict, None] = None
-    payment_string: Union[str, None] = None
-    verification_link: Union[str, None] = None
-    buyer_email: Union[str, None] = None
+    exchange_rates: Union[Dict[str, Dict[str, float]], None] = None
     merchant_name: Union[str, None] = None
     forced_buyer_selected_wallet: Union[str, None] = None
     forced_buyer_selected_transaction_currency: Union[str, None] = None

src/bitpay/models/invoice/invoice_status.py

@@ -1,16 +1,18 @@
 """
 InvoiceStatus
 """
+from enum import Enum
 
 
-class InvoiceStatus:
+class InvoiceStatus(Enum):
     """
     Invoice Status
     """
 
-    New = "new"
-    Paid = "paid"
-    Confirmed = "confirmed"
-    Complete = "complete"
-    Expired = "expired"
-    Invalid = "invalid"
+    NEW = "new"
+    PAID = "paid"
+    CONFIRMED = "confirmed"
+    COMPLETE = "complete"
+    EXPIRED = "expired"
+    INVALID = "invalid"
+    DECLINED = "declined"

src/bitpay/models/invoice/invoice_webhook.py

@@ -0,0 +1,23 @@
+from typing import Union, Dict
+
+from bitpay.models.bitpay_model import BitPayModel
+from bitpay.models.invoice.buyer_fields import BuyerFields
+
+
+class InvoiceWebhook(BitPayModel):
+    amount_paid: Union[float, None] = None
+    buyer_fields: Union[BuyerFields, None] = None
+    currency: Union[str, None] = None
+    currency_time: Union[str, None] = None
+    exception_status: Union[str, None] = None
+    exchange_rates: Union[Dict[str, Dict[str, float]], None] = None
+    id: Union[str, None] = None
+    invoice_time: Union[str, None] = None
+    order_id: Union[str, None] = None
+    payment_subtotals: Union[Dict[str, int], None] = None
+    payment_totals: Union[Dict[str, int], None] = None
+    pos_data: Union[str, None] = None
+    price: Union[float, None] = None
+    status: Union[str, None] = None
+    transaction_currency: Union[str, None] = None
+    url: Union[str, None] = None