dime-python-sdk 1.3.0__tar.gz → 1.3.1__tar.gz

{dime_python_sdk-1.3.0 → dime_python_sdk-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: dime-python-sdk
-Version: 1.3.0
+Version: 1.3.1
 Summary: Python client for the Dime Payments API
 Author: Dime Technology
 License: MIT License
@@ -218,6 +218,11 @@ item (a fund or designation). Draft invoices can be edited; once sent they are l
 Identify the customer with `customer_uuid` — the same uuid every other resource uses, and the only
 identifier the customer endpoints return. `customer_id` is still accepted for older integrations.
 
+**Statuses.** `invoice.status` is one of `draft`, `sent`, `viewed`, `partially_paid`, `paid`, `void` or
+`refunded`. `paid` is not always final: if the customer's bank returns an ACH payment, the invoice is
+reopened (back to `partially_paid`, `viewed` or `sent`, with `amount_paid` and `balance` updated) and an
+`invoice_payment_returned` webhook fires. Re-read the invoice rather than caching a `paid` status forever.
+
 ```python
 # Look up (or create) the merchant items a line can reference
 items = dime.invoices.list_items('000010')

{dime_python_sdk-1.3.0 → dime_python_sdk-1.3.1}/README.md

@@ -174,6 +174,11 @@ item (a fund or designation). Draft invoices can be edited; once sent they are l
 Identify the customer with `customer_uuid` — the same uuid every other resource uses, and the only
 identifier the customer endpoints return. `customer_id` is still accepted for older integrations.
 
+**Statuses.** `invoice.status` is one of `draft`, `sent`, `viewed`, `partially_paid`, `paid`, `void` or
+`refunded`. `paid` is not always final: if the customer's bank returns an ACH payment, the invoice is
+reopened (back to `partially_paid`, `viewed` or `sent`, with `amount_paid` and `balance` updated) and an
+`invoice_payment_returned` webhook fires. Re-read the invoice rather than caching a `paid` status forever.
+
 ```python
 # Look up (or create) the merchant items a line can reference
 items = dime.invoices.list_items('000010')

{dime_python_sdk-1.3.0 → dime_python_sdk-1.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "dime-python-sdk"
-version = "1.3.0"
+version = "1.3.1"
 description = "Python client for the Dime Payments API"
 readme = "README.md"
 requires-python = ">=3.10"

{dime_python_sdk-1.3.0 → dime_python_sdk-1.3.1}/src/dime_payments/config.py

@@ -8,7 +8,7 @@ if TYPE_CHECKING:
 
 class Config:
     DEFAULT_BASE_URL = 'https://app.dimepayments.com'
-    VERSION = '1.3.0'
+    VERSION = '1.3.1'
 
     def __init__(
         self,

{dime_python_sdk-1.3.0 → dime_python_sdk-1.3.1}/src/dime_payments/http/transport.py

@@ -11,7 +11,7 @@ from .error_handler import ErrorHandler
 if TYPE_CHECKING:
     from ..config import Config
 
-SDK_VERSION = '1.3.0'
+SDK_VERSION = '1.3.1'
 
 
 class Transport:

{dime_python_sdk-1.3.0 → dime_python_sdk-1.3.1}/src/dime_payments/resources/invoices.py

@@ -25,6 +25,12 @@ class Invoices(AbstractResource):
     """
 
     def list(self, sid: str, filters: dict[str, Any] | None = None) -> CursorPage[Invoice]:
+        """
+        List invoices for a merchant.
+
+        ``filters['status']`` is one of draft, sent, viewed, partially_paid, paid, void,
+        refunded, overdue or all.
+        """
         body = self._envelope({'sid': sid}, filters or {})
         return self._paginate('GET', 'invoices', body, Invoice.from_dict)