feat(api)!: updates book transfer status, updates to transactions, add currency model (#564)

stainless-app[bot] · stainless-app[bot] · commit ce6480ff5f9a · 2024-09-17T14:08:19.000Z
- Breaking: Removed book transfer status `PENDING`. While technically a breaking change, that was a mistake and should not impact user code, the API never accepted `PENDING` as a status for book transfer.
- Add book transfer status `REVERSED`
- Add `updated` and `amounts` fields to transactions
- Add shared model `Currency`
# Migration
The SDK previously stated that `PENDING` was an accepted value for book transfer status. That was a mistake, `PENDING` has never been accepted by the API for book transfers.
While this is a breaking change we do not expect user code to be impacted.
diff --git a/api.md b/api.md
@@ -1,7 +1,7 @@
 # Shared Types
 
 ```python
-from lithic.types import Address, Carrier, Document, ShippingAddress
+from lithic.types import Address, Carrier, Currency, Document, ShippingAddress
 ```
 
 # Lithic
diff --git a/src/lithic/resources/events/events.py b/src/lithic/resources/events/events.py
@@ -99,6 +99,7 @@ def list(
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -116,6 +117,7 @@ def list(
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
@@ -348,6 +350,7 @@ def list(
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -365,6 +368,7 @@ def list(
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
diff --git a/src/lithic/resources/events/subscriptions.py b/src/lithic/resources/events/subscriptions.py
@@ -66,6 +66,7 @@ def create(
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -83,6 +84,7 @@ def create(
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
@@ -189,6 +191,7 @@ def update(
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -206,6 +209,7 @@ def update(
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
@@ -618,6 +622,7 @@ def send_simulated_example(
             "account_holder.created",
             "account_holder.updated",
             "account_holder.verification",
+            "auth_rules.performance_report.created",
             "balance.updated",
             "book_transfer_transaction.created",
             "card.created",
@@ -635,6 +640,7 @@ def send_simulated_example(
             "external_bank_account.created",
             "external_bank_account.updated",
             "financial_account.created",
+            "financial_account.updated",
             "payment_transaction.created",
             "payment_transaction.updated",
             "settlement_report.updated",
@@ -717,6 +723,7 @@ async def create(
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -734,6 +741,7 @@ async def create(
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
@@ -840,6 +848,7 @@ async def update(
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -857,6 +866,7 @@ async def update(
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
@@ -1269,6 +1279,7 @@ async def send_simulated_example(
             "account_holder.created",
             "account_holder.updated",
             "account_holder.verification",
+            "auth_rules.performance_report.created",
             "balance.updated",
             "book_transfer_transaction.created",
             "card.created",
@@ -1286,6 +1297,7 @@ async def send_simulated_example(
             "external_bank_account.created",
             "external_bank_account.updated",
             "financial_account.created",
+            "financial_account.updated",
             "payment_transaction.created",
             "payment_transaction.updated",
             "settlement_report.updated",
diff --git a/src/lithic/types/__init__.py b/src/lithic/types/__init__.py
@@ -4,7 +4,13 @@
 
 from .card import Card as Card
 from .event import Event as Event
-from .shared import Address as Address, Carrier as Carrier, Document as Document, ShippingAddress as ShippingAddress
+from .shared import (
+    Address as Address,
+    Carrier as Carrier,
+    Currency as Currency,
+    Document as Document,
+    ShippingAddress as ShippingAddress,
+)
 from .account import Account as Account
 from .balance import Balance as Balance
 from .dispute import Dispute as Dispute
diff --git a/src/lithic/types/book_transfer_response.py b/src/lithic/types/book_transfer_response.py
@@ -85,11 +85,11 @@ class BookTransferResponse(BaseModel):
     (e.g., cents).
     """
 
-    status: Literal["DECLINED", "PENDING", "SETTLED"]
+    status: Literal["DECLINED", "REVERSED", "SETTLED"]
     """Status types: \\** `DECLINED` - The transfer was declined.
 
-    - `PENDING` - The transfer is pending release from a hold. \\** `SETTLED` - The
-      transfer is completed.
+    - `REVERSED` - The transfer was reversed \\** `SETTLED` - The transfer is
+      completed.
     """
 
     to_financial_account_token: object
diff --git a/src/lithic/types/event.py b/src/lithic/types/event.py
@@ -23,6 +23,7 @@ class Event(BaseModel):
         "account_holder.created",
         "account_holder.updated",
         "account_holder.verification",
+        "auth_rules.performance_report.created",
         "balance.updated",
         "book_transfer_transaction.created",
         "card.created",
@@ -40,6 +41,7 @@ class Event(BaseModel):
         "external_bank_account.created",
         "external_bank_account.updated",
         "financial_account.created",
+        "financial_account.updated",
         "payment_transaction.created",
         "payment_transaction.updated",
         "settlement_report.updated",
diff --git a/src/lithic/types/event_list_params.py b/src/lithic/types/event_list_params.py
@@ -35,6 +35,7 @@ class EventListParams(TypedDict, total=False):
             "account_holder.created",
             "account_holder.updated",
             "account_holder.verification",
+            "auth_rules.performance_report.created",
             "balance.updated",
             "book_transfer_transaction.created",
             "card.created",
@@ -52,6 +53,7 @@ class EventListParams(TypedDict, total=False):
             "external_bank_account.created",
             "external_bank_account.updated",
             "financial_account.created",
+            "financial_account.updated",
             "payment_transaction.created",
             "payment_transaction.updated",
             "settlement_report.updated",
diff --git a/src/lithic/types/event_subscription.py b/src/lithic/types/event_subscription.py
@@ -26,6 +26,7 @@ class EventSubscription(BaseModel):
                 "account_holder.created",
                 "account_holder.updated",
                 "account_holder.verification",
+                "auth_rules.performance_report.created",
                 "balance.updated",
                 "book_transfer_transaction.created",
                 "card.created",
@@ -43,6 +44,7 @@ class EventSubscription(BaseModel):
                 "external_bank_account.created",
                 "external_bank_account.updated",
                 "financial_account.created",
+                "financial_account.updated",
                 "payment_transaction.created",
                 "payment_transaction.updated",
                 "settlement_report.updated",
diff --git a/src/lithic/types/events/subscription_create_params.py b/src/lithic/types/events/subscription_create_params.py
@@ -23,6 +23,7 @@ class SubscriptionCreateParams(TypedDict, total=False):
             "account_holder.created",
             "account_holder.updated",
             "account_holder.verification",
+            "auth_rules.performance_report.created",
             "balance.updated",
             "book_transfer_transaction.created",
             "card.created",
@@ -40,6 +41,7 @@ class SubscriptionCreateParams(TypedDict, total=False):
             "external_bank_account.created",
             "external_bank_account.updated",
             "financial_account.created",
+            "financial_account.updated",
             "payment_transaction.created",
             "payment_transaction.updated",
             "settlement_report.updated",
diff --git a/src/lithic/types/events/subscription_send_simulated_example_params.py b/src/lithic/types/events/subscription_send_simulated_example_params.py
@@ -12,6 +12,7 @@ class SubscriptionSendSimulatedExampleParams(TypedDict, total=False):
         "account_holder.created",
         "account_holder.updated",
         "account_holder.verification",
+        "auth_rules.performance_report.created",
         "balance.updated",
         "book_transfer_transaction.created",
         "card.created",
@@ -29,6 +30,7 @@ class SubscriptionSendSimulatedExampleParams(TypedDict, total=False):
         "external_bank_account.created",
         "external_bank_account.updated",
         "financial_account.created",
+        "financial_account.updated",
         "payment_transaction.created",
         "payment_transaction.updated",
         "settlement_report.updated",
diff --git a/src/lithic/types/events/subscription_update_params.py b/src/lithic/types/events/subscription_update_params.py
@@ -23,6 +23,7 @@ class SubscriptionUpdateParams(TypedDict, total=False):
             "account_holder.created",
             "account_holder.updated",
             "account_holder.verification",
+            "auth_rules.performance_report.created",
             "balance.updated",
             "book_transfer_transaction.created",
             "card.created",
@@ -40,6 +41,7 @@ class SubscriptionUpdateParams(TypedDict, total=False):
             "external_bank_account.created",
             "external_bank_account.updated",
             "financial_account.created",
+            "financial_account.updated",
             "payment_transaction.created",
             "payment_transaction.updated",
             "settlement_report.updated",
diff --git a/src/lithic/types/shared/__init__.py b/src/lithic/types/shared/__init__.py
@@ -2,5 +2,6 @@
 
 from .address import Address as Address
 from .carrier import Carrier as Carrier
+from .currency import Currency as Currency
 from .document import Document as Document
 from .shipping_address import ShippingAddress as ShippingAddress
diff --git a/src/lithic/types/shared/address.py b/src/lithic/types/shared/address.py
@@ -17,24 +17,15 @@ class Address(BaseModel):
     country: str
     """Valid country code.
 
-    Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3
+    USA and CAN are supported, entered in uppercase ISO 3166-1 alpha-3
     three-character format.
     """
 
     postal_code: str
-    """Valid postal code.
-
-    Only USA postal codes (ZIP codes) are currently supported, entered as a
-    five-digit postal code or nine-digit postal code (ZIP+4) using the format
-    12345-1234.
-    """
+    """Valid postal code."""
 
     state: str
-    """Valid state code.
-
-    Only USA state codes are currently supported, entered in uppercase ISO 3166-2
-    two-character format.
-    """
+    """Valid state code."""
 
     address2: Optional[str] = None
     """Unit or apartment number (if applicable)."""
diff --git a/src/lithic/types/shared/currency.py b/src/lithic/types/shared/currency.py
diff --git a/src/lithic/types/shared/document.py b/src/lithic/types/shared/document.py
diff --git a/src/lithic/types/shared_params/address.py b/src/lithic/types/shared_params/address.py
diff --git a/src/lithic/types/transaction.py b/src/lithic/types/transaction.py
diff --git a/tests/api_resources/test_account_holders.py b/tests/api_resources/test_account_holders.py
