SP-738 Type Review: Python

Author: mwarzybok-sumoheavy

src/bitpay/models/invoice/invoice.py

@@ -5,6 +5,7 @@
 from pydantic import Field
 from .buyer import Buyer
 from .buyer_provided_info import BuyerProvidedInfo
+from .invoice_refund_addresses import InvoiceRefundAddresses
 from .miner_fees import MinerFees
 from .refund_info import RefundInfo
 from .shopper import Shopper
@@ -46,7 +47,7 @@ class Invoice(BitPayModel):
     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
+    refund_addresses: Union[List[Dict[str, InvoiceRefundAddresses]], None] = None
     close_url: Union[str, None] = Field(alias="closeURL", default=None)
     auto_redirect: Union[bool, None] = False
     json_paypro_required: Union[bool, None] = False

src/bitpay/models/invoice/invoice_refund_addresses.py

@@ -0,0 +1,16 @@
+from datetime import datetime
+from pydantic import field_serializer
+from typing import Union
+
+from bitpay.models.bitpay_model import BitPayModel
+
+
+class InvoiceRefundAddresses(BitPayModel):
+    date: Union[datetime, None]
+    email: Union[str, None]
+    tag: Union[int, None] = None
+    type: Union[str, None] = None
+
+    @field_serializer("date")
+    def serialize_datetime(self, dt: datetime) -> str:
+        return super().serialize_datetime_to_iso8601(dt)

src/bitpay/models/invoice/invoice_webhook.py

@@ -21,3 +21,5 @@ class InvoiceWebhook(BitPayModel):
     status: Union[str, None] = None
     transaction_currency: Union[str, None] = None
     url: Union[str, None] = None
+    in_invoice_id: Union[str, None] = None
+    in_payment_request: Union[str, None] = None

src/bitpay/models/invoice/refund_webhook.py

@@ -18,6 +18,14 @@ class RefundWebhook(BitPayModel):
     request_date: Union[datetime, None] = None
     status: Union[str, None] = None
     support_request: Union[str, None] = None
+    reference: Union[str, None] = None
+    guid: Union[str, None] = None
+    refund_address: Union[str, None] = None
+    type: Union[str, None] = None
+    txid: Union[str, None] = None
+    transaction_currency: Union[str, None] = None
+    transaction_amount: Union[float, None] = None
+    transaction_refund_fee: Union[float, None] = None
 
     @field_serializer("request_date", "last_refund_notification")
     def serialize_datetime(self, dt: datetime) -> str:

src/bitpay/models/payout/payout_transaction.py

@@ -15,7 +15,7 @@ class PayoutTransaction(BitPayModel):
     txid: Union[str, None] = None
     amount: Union[float, None] = None
     date: Union[datetime, None] = None
-    confirmations: Union[str, None] = None
+    confirmations: Union[int, None] = None
 
     @field_serializer("date")
     def serialize_datetime_to_iso8601(self, dt: datetime) -> str:

src/bitpay/models/payout/payout_webhook.py

@@ -0,0 +1,27 @@
+from datetime import datetime
+from typing import Union, Dict, List
+
+from bitpay.models.bitpay_model import BitPayModel
+from bitpay.models.payout.payout_transaction import PayoutTransaction
+
+
+class PayoutWebhook(BitPayModel):
+    id: Union[str, None] = None
+    recipient_id: Union[str, None] = None
+    shopper_id: Union[str, None] = None
+    price: Union[float, None] = None
+    currency: Union[str, None] = None
+    ledger_currency: Union[str, None] = None
+    exchange_rates: Union[Dict[str, Dict[str, float]], None] = None
+    email: Union[str, None] = None
+    reference: Union[str, None] = None
+    label: Union[str, None] = None
+    notification_url: Union[str, None] = None
+    notification_email: Union[str, None] = None
+    effective_date: Union[datetime, None] = None
+    request_date: Union[datetime, None] = None
+    status: Union[str, None] = None
+    transactions: Union[List[PayoutTransaction], None] = None
+    account_id: Union[str, None] = None
+    date: Union[datetime, None] = None
+    group_id: Union[str, None] = None

tests/unit/json/create_invoice_response.json

@@ -31,7 +31,15 @@
     "notify": true
   },
   "autoRedirect": true,
-  "refundAddresses": [],
+  "refundAddresses": [
+    {
+      "n2MDYgEhxCAnuoVd1JpPmvxZShE6rQA6zv": {
+        "type": "buyerSupplied",
+        "date": "2024-01-08T23:50:56.556Z",
+        "email": "[email protected]"
+      }
+    }
+  ],
   "refundAddressRequestPending": false,
   "buyerProvidedEmail": "[email protected]",
   "buyerProvidedInfo": {

tests/unit/test_client.py

@@ -214,6 +214,7 @@ def test_create_invoice_by_merchant(mocker):
         result.universal_codes.payment_string
         == "https://link.test.bitpay.com/i/UZjwcYkWAKfTMn9J1yyfs4"
     )
+    assert result.refund_addresses[0].get("n2MDYgEhxCAnuoVd1JpPmvxZShE6rQA6zv").date.strftime("%Y-%m-%d %H:%M:%S") == "2024-01-08 23:50:56"
 
 
 @pytest.mark.unit