feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: ec98ee98f7777d5d0f87bcb178e47d8d
+openapi_spec_hash: 9a0cb386fed2275f199e490e83da391c
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

src/increase/resources/check_transfers.py

@@ -348,8 +348,12 @@ def stop_payment(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
         idempotency_key: str | None = None,
     ) -> CheckTransfer:
-        """
-        Stop payment on a Check Transfer
+        """Request a stop payment on a Check Transfer.
+
+        This can be done any time before the
+        check is deposited. A stopped check cannot be deposited and the funds held by
+        the transfer's Pending Transaction are released back to the account's available
+        balance.
 
         Args:
           check_transfer_id: The identifier of the Check Transfer.
@@ -710,8 +714,12 @@ async def stop_payment(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
         idempotency_key: str | None = None,
     ) -> CheckTransfer:
-        """
-        Stop payment on a Check Transfer
+        """Request a stop payment on a Check Transfer.
+
+        This can be done any time before the
+        check is deposited. A stopped check cannot be deposited and the funds held by
+        the transfer's Pending Transaction are released back to the account's available
+        balance.
 
         Args:
           check_transfer_id: The identifier of the Check Transfer.

src/increase/resources/simulations/inbound_check_deposits.py

@@ -62,10 +62,11 @@ def create(
 
         This imitates someone
         depositing a check at their bank that was issued from your account. It may or
-        may not be associated with a Check Transfer. Increase will evaluate the Inbound
-        Check Deposit as we would in production and either create a Transaction or a
-        Declined Transaction as a result. You can inspect the resulting Inbound Check
-        Deposit object to see the result.
+        may not be associated with a Check Transfer. The resulting Inbound Check Deposit
+        will have a `status` of `pending`, and after an hour Increase will evaluate it
+        as we would in production and either create a Transaction or a Declined
+        Transaction as a result. To resolve it sooner, use the simulation to accept an
+        Inbound Check Deposit or the API to decline one.
 
         Args:
           account_number_id: The identifier of the Account Number the Inbound Check Deposit will be against.
@@ -230,10 +231,11 @@ async def create(
 
         This imitates someone
         depositing a check at their bank that was issued from your account. It may or
-        may not be associated with a Check Transfer. Increase will evaluate the Inbound
-        Check Deposit as we would in production and either create a Transaction or a
-        Declined Transaction as a result. You can inspect the resulting Inbound Check
-        Deposit object to see the result.
+        may not be associated with a Check Transfer. The resulting Inbound Check Deposit
+        will have a `status` of `pending`, and after an hour Increase will evaluate it
+        as we would in production and either create a Transaction or a Declined
+        Transaction as a result. To resolve it sooner, use the simulation to accept an
+        Inbound Check Deposit or the API to decline one.
 
         Args:
           account_number_id: The identifier of the Account Number the Inbound Check Deposit will be against.

src/increase/types/check_transfer.py

@@ -287,10 +287,8 @@ class PhysicalCheck(BaseModel):
     shipping_method: Literal["usps_first_class", "fedex_overnight"]
     """The shipping method for the check.
 
-    - `usps_first_class` - Ship the checks via USPS First Class, which supports a
-      maximum of 1000 pages (checks and attachments combined).
-    - `fedex_overnight` - Ship the checks via FedEx Overnight, which supports a
-      maximum of 50 pages (checks and attachments combined).
+    - `usps_first_class` - USPS First Class
+    - `fedex_overnight` - FedEx Overnight
     """
 
     signature: PhysicalCheckSignature

src/increase/types/check_transfer_create_params.py

@@ -233,10 +233,8 @@ class PhysicalCheck(TypedDict, total=False, extra_items=object):  # type: ignore
     For details on pricing, timing, and restrictions, see
     https://increase.com/documentation/originating-checks#printing-checks .
 
-    - `usps_first_class` - Ship the checks via USPS First Class, which supports a
-      maximum of 1000 pages (checks and attachments combined).
-    - `fedex_overnight` - Ship the checks via FedEx Overnight, which supports a
-      maximum of 50 pages (checks and attachments combined).
+    - `usps_first_class` - USPS First Class
+    - `fedex_overnight` - FedEx Overnight
     """
 
     signature: PhysicalCheckSignature

src/increase/types/event.py

@@ -92,6 +92,8 @@ class Event(BaseModel):
         "inbound_wire_drawdown_request.created",
         "inbound_wire_transfer.created",
         "inbound_wire_transfer.updated",
+        "interest_rate_plan.created",
+        "interest_rate_plan.updated",
         "intrafi_account_enrollment.created",
         "intrafi_account_enrollment.updated",
         "intrafi_exclusion.created",
@@ -250,6 +252,10 @@ class Event(BaseModel):
       created.
     - `inbound_wire_transfer.updated` - Occurs whenever an Inbound Wire Transfer is
       updated.
+    - `interest_rate_plan.created` - Occurs whenever an Interest Rate Plan is
+      created.
+    - `interest_rate_plan.updated` - Occurs whenever an Interest Rate Plan is
+      updated.
     - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
       Enrollment is created.
     - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account

src/increase/types/event_list_params.py

@@ -104,6 +104,8 @@ class EventListParams(TypedDict, total=False):
                 "inbound_wire_drawdown_request.created",
                 "inbound_wire_transfer.created",
                 "inbound_wire_transfer.updated",
+                "interest_rate_plan.created",
+                "interest_rate_plan.updated",
                 "intrafi_account_enrollment.created",
                 "intrafi_account_enrollment.updated",
                 "intrafi_exclusion.created",

src/increase/types/event_subscription.py

@@ -82,6 +82,8 @@ class SelectedEventCategory(BaseModel):
             "inbound_wire_drawdown_request.created",
             "inbound_wire_transfer.created",
             "inbound_wire_transfer.updated",
+            "interest_rate_plan.created",
+            "interest_rate_plan.updated",
             "intrafi_account_enrollment.created",
             "intrafi_account_enrollment.updated",
             "intrafi_exclusion.created",
@@ -238,6 +240,10 @@ class SelectedEventCategory(BaseModel):
       created.
     - `inbound_wire_transfer.updated` - Occurs whenever an Inbound Wire Transfer is
       updated.
+    - `interest_rate_plan.created` - Occurs whenever an Interest Rate Plan is
+      created.
+    - `interest_rate_plan.updated` - Occurs whenever an Interest Rate Plan is
+      updated.
     - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
       Enrollment is created.
     - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account

src/increase/types/event_subscription_create_params.py

@@ -111,6 +111,8 @@ class SelectedEventCategory(TypedDict, total=False):
             "inbound_wire_drawdown_request.created",
             "inbound_wire_transfer.created",
             "inbound_wire_transfer.updated",
+            "interest_rate_plan.created",
+            "interest_rate_plan.updated",
             "intrafi_account_enrollment.created",
             "intrafi_account_enrollment.updated",
             "intrafi_exclusion.created",
@@ -267,6 +269,10 @@ class SelectedEventCategory(TypedDict, total=False):
       created.
     - `inbound_wire_transfer.updated` - Occurs whenever an Inbound Wire Transfer is
       updated.
+    - `interest_rate_plan.created` - Occurs whenever an Interest Rate Plan is
+      created.
+    - `interest_rate_plan.updated` - Occurs whenever an Interest Rate Plan is
+      updated.
     - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
       Enrollment is created.
     - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account

src/increase/types/inbound_check_deposit.py

@@ -89,6 +89,13 @@ class InboundCheckDeposit(BaseModel):
     amount: int
     """The deposited amount in USD cents."""
 
+    automatically_resolves_at: datetime
+    """
+    The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+    the Inbound Check Deposit will be automatically resolved if it has not been
+    actioned by then.
+    """
+
     back_image_file_id: Optional[str] = None
     """The ID for the File containing the image of the back of the check."""
 

src/increase/types/routing_number_list_response.py

@@ -27,6 +27,13 @@ class RoutingNumberListResponse(BaseModel):
     name: str
     """The name of the financial institution belonging to a routing number."""
 
+    real_time_payments_request_for_payment: Literal["supported", "not_supported"]
+    """This routing number's support for Real-Time Payments Requests for Payment.
+
+    - `supported` - The routing number can receive this transfer type.
+    - `not_supported` - The routing number cannot receive this transfer type.
+    """
+
     real_time_payments_transfers: Literal["supported", "not_supported"]
     """This routing number's support for Real-Time Payments Transfers.
 

src/increase/types/unwrap_webhook_event.py

@@ -92,6 +92,8 @@ class UnwrapWebhookEvent(BaseModel):
         "inbound_wire_drawdown_request.created",
         "inbound_wire_transfer.created",
         "inbound_wire_transfer.updated",
+        "interest_rate_plan.created",
+        "interest_rate_plan.updated",
         "intrafi_account_enrollment.created",
         "intrafi_account_enrollment.updated",
         "intrafi_exclusion.created",
@@ -250,6 +252,10 @@ class UnwrapWebhookEvent(BaseModel):
       created.
     - `inbound_wire_transfer.updated` - Occurs whenever an Inbound Wire Transfer is
       updated.
+    - `interest_rate_plan.created` - Occurs whenever an Interest Rate Plan is
+      created.
+    - `interest_rate_plan.updated` - Occurs whenever an Interest Rate Plan is
+      updated.
     - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
       Enrollment is created.
     - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account

src/increase/types/wire_drawdown_request.py

@@ -31,7 +31,7 @@ class CreditorAddress(BaseModel):
     """The second line of the address."""
 
     postal_code: Optional[str] = None
-    """The ZIP code of the address."""
+    """The postal code of the address."""
 
     state: Optional[str] = None
     """The address state."""
@@ -57,7 +57,7 @@ class DebtorAddress(BaseModel):
     """The second line of the address."""
 
     postal_code: Optional[str] = None
-    """The ZIP code of the address."""
+    """The postal code of the address."""
 
     state: Optional[str] = None
     """The address state."""

src/increase/types/wire_drawdown_request_create_params.py

@@ -80,7 +80,7 @@ class CreditorAddress(TypedDict, total=False):
     """The second line of the address. This might be the floor or room number."""
 
     postal_code: str
-    """The ZIP code of the address."""
+    """The postal code of the address."""
 
     state: str
     """The address state."""
@@ -106,7 +106,7 @@ class DebtorAddress(TypedDict, total=False):
     """The second line of the address. This might be the floor or room number."""
 
     postal_code: str
-    """The ZIP code of the address."""
+    """The postal code of the address."""
 
     state: str
     """The address state."""

src/increase/types/wire_transfer.py

@@ -129,6 +129,18 @@ class CreditorAddress(BaseModel):
     unstructured: Optional[CreditorAddressUnstructured] = None
     """Unstructured address lines."""
 
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
+
 
 class Creditor(BaseModel):
     """The person or business that is receiving the funds from the transfer."""
@@ -159,6 +171,18 @@ class DebtorAddress(BaseModel):
     unstructured: Optional[DebtorAddressUnstructured] = None
     """Unstructured address lines."""
 
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
+
 
 class Debtor(BaseModel):
     """The person or business whose funds are being transferred."""

src/increase/types/wire_transfer_create_params.py

@@ -84,10 +84,10 @@ class CreditorAddressUnstructured(TypedDict, total=False):
     """The address line 3."""
 
 
-class CreditorAddress(TypedDict, total=False):
+class CreditorAddress(TypedDict, total=False, extra_items=object):  # type: ignore[call-arg]
     """The person or business's address."""
 
-    unstructured: Required[CreditorAddressUnstructured]
+    unstructured: CreditorAddressUnstructured
     """Unstructured address lines."""
 
 
@@ -171,10 +171,10 @@ class DebtorAddressUnstructured(TypedDict, total=False):
     """The address line 3."""
 
 
-class DebtorAddress(TypedDict, total=False):
+class DebtorAddress(TypedDict, total=False, extra_items=object):  # type: ignore[call-arg]
     """The person or business's address."""
 
-    unstructured: Required[DebtorAddressUnstructured]
+    unstructured: DebtorAddressUnstructured
     """Unstructured address lines."""