feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: ec98ee98f7777d5d0f87bcb178e47d8d
+openapi_spec_hash: e431b55e71f915052b29860f3d25697e
 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/external_accounts.py

@@ -77,7 +77,7 @@ def create(
               - `individual` - The External Account is owned by an individual.
               - `unknown` - It's unknown what kind of entity owns the External Account.
 
-          funding: The type of the destination account. Defaults to `checking`.
+          funding: The type of the destination account.
 
               - `checking` - A checking account.
               - `savings` - A savings account.
@@ -345,7 +345,7 @@ async def create(
               - `individual` - The External Account is owned by an individual.
               - `unknown` - It's unknown what kind of entity owns the External Account.
 
-          funding: The type of the destination account. Defaults to `checking`.
+          funding: The type of the destination account.
 
               - `checking` - A checking account.
               - `savings` - A savings account.

src/increase/resources/files.py

@@ -125,10 +125,11 @@ def create(
               - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
                 wallet apps. This must be a 100x100 pixel PNG.
               - `physical_card_front` - A card image to be printed on the front of a physical
-                card. This must be a 2100x1344 pixel PNG with no other color but black.
+                card. This must be a 2100x1344 pixel PNG with a density of 600 dots per inch
+                (DPI) and no other color but black.
               - `physical_card_carrier` - An image representing the entirety of the carrier
-                used for a physical card. This must be a 2550x3300 pixel PNG with no other
-                color but black.
+                used for a physical card. This must be a 2550x3300 pixel PNG with a density of
+                300 dots per inch (DPI) and no other color but black.
               - `document_request` - A document requested by Increase.
               - `entity_supplemental_document` - A supplemental document associated an an
                 Entity.
@@ -406,10 +407,11 @@ async def create(
               - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
                 wallet apps. This must be a 100x100 pixel PNG.
               - `physical_card_front` - A card image to be printed on the front of a physical
-                card. This must be a 2100x1344 pixel PNG with no other color but black.
+                card. This must be a 2100x1344 pixel PNG with a density of 600 dots per inch
+                (DPI) and no other color but black.
               - `physical_card_carrier` - An image representing the entirety of the carrier
-                used for a physical card. This must be a 2550x3300 pixel PNG with no other
-                color but black.
+                used for a physical card. This must be a 2550x3300 pixel PNG with a density of
+                300 dots per inch (DPI) and no other color but black.
               - `document_request` - A document requested by Increase.
               - `entity_supplemental_document` - A supplemental document associated an an
                 Entity.

src/increase/resources/physical_card_profiles.py

@@ -67,13 +67,17 @@ def create(
         Create a Physical Card Profile
 
         Args:
-          carrier_image_file_id: The identifier of the File containing the physical card's carrier image.
+          carrier_image_file_id: The identifier of the File containing the physical card's carrier image. This
+              must have `purpose: physical_card_carrier` and be a 2550x3300 pixel PNG with a
+              density of 300 dots per inch (DPI).
 
           contact_phone: A phone number the user can contact to receive support for their card.
 
           description: A description you can use to identify the Card Profile.
 
-          front_image_file_id: The identifier of the File containing the physical card's front image.
+          front_image_file_id: The identifier of the File containing the physical card's front image. This must
+              have `purpose: physical_card_front` and be a 2100x1344 pixel PNG with a density
+              of 600 dots per inch (DPI).
 
           program_id: The identifier for the Program that this Physical Card Profile falls under.
 
@@ -375,13 +379,17 @@ async def create(
         Create a Physical Card Profile
 
         Args:
-          carrier_image_file_id: The identifier of the File containing the physical card's carrier image.
+          carrier_image_file_id: The identifier of the File containing the physical card's carrier image. This
+              must have `purpose: physical_card_carrier` and be a 2550x3300 pixel PNG with a
+              density of 300 dots per inch (DPI).
 
           contact_phone: A phone number the user can contact to receive support for their card.
 
           description: A description you can use to identify the Card Profile.
 
-          front_image_file_id: The identifier of the File containing the physical card's front image.
+          front_image_file_id: The identifier of the File containing the physical card's front image. This must
+              have `purpose: physical_card_front` and be a 2100x1344 pixel PNG with a density
+              of 600 dots per inch (DPI).
 
           program_id: The identifier for the Program that this Physical Card Profile falls under.
 

src/increase/resources/simulations/ach_transfers.py

@@ -266,7 +266,6 @@ def return_(
               a return the bank believes was initiated under questionable circumstances.
 
           reason: The reason why the Federal Reserve or destination bank returned this transfer.
-              Defaults to `no_account`.
 
               - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
                 Sometimes abbreviated to "NSF."
@@ -803,7 +802,6 @@ async def return_(
               a return the bank believes was initiated under questionable circumstances.
 
           reason: The reason why the Federal Reserve or destination bank returned this transfer.
-              Defaults to `no_account`.
 
               - `insufficient_fund` - Code R01. Insufficient funds in the receiving account.
                 Sometimes abbreviated to "NSF."

src/increase/resources/simulations/check_deposits.py

@@ -72,8 +72,7 @@ def adjustment(
               other bank and is a debit to your account. Defaults to the negative of the Check
               Deposit amount.
 
-          reason: The reason for the adjustment. Defaults to `non_conforming_item`, which is often
-              used for a low quality image that the recipient wasn't able to handle.
+          reason: The reason for the adjustment.
 
               - `late_return` - The return was initiated too late and the receiving
                 institution has responded with a Late Return Claim.
@@ -305,8 +304,7 @@ async def adjustment(
               other bank and is a debit to your account. Defaults to the negative of the Check
               Deposit amount.
 
-          reason: The reason for the adjustment. Defaults to `non_conforming_item`, which is often
-              used for a low quality image that the recipient wasn't able to handle.
+          reason: The reason for the adjustment.
 
               - `late_return` - The return was initiated too late and the receiving
                 institution has responded with a Late Return Claim.

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/entity_create_params.py

@@ -358,8 +358,6 @@ class CorporationLegalIdentifier(TypedDict, total=False):
     category: Literal["us_employer_identification_number", "other"]
     """The category of the legal identifier.
 
-    If not provided, the default is `us_employer_identification_number`.
-
     - `us_employer_identification_number` - The Employer Identification Number (EIN)
       for the company. The EIN is a 9-digit number assigned by the IRS; submit it as
       nine digits with no dashes or other separators.

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/external_account_create_params.py

@@ -29,7 +29,7 @@ class ExternalAccountCreateParams(TypedDict, total=False):
     """
 
     funding: Literal["checking", "savings", "general_ledger", "other"]
-    """The type of the destination account. Defaults to `checking`.
+    """The type of the destination account.
 
     - `checking` - A checking account.
     - `savings` - A savings account.

src/increase/types/file.py

@@ -119,11 +119,12 @@ class File(BaseModel):
     - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
       wallet apps. This must be a 100x100 pixel PNG.
     - `physical_card_front` - A card image to be printed on the front of a physical
-      card. This must be a 2100x1344 pixel PNG with no other color but black.
+      card. This must be a 2100x1344 pixel PNG with a density of 600 dots per inch
+      (DPI) and no other color but black.
     - `physical_card_back` - The image to be printed on the back of a physical card.
     - `physical_card_carrier` - An image representing the entirety of the carrier
-      used for a physical card. This must be a 2550x3300 pixel PNG with no other
-      color but black.
+      used for a physical card. This must be a 2550x3300 pixel PNG with a density of
+      300 dots per inch (DPI) and no other color but black.
     - `document_request` - A document requested by Increase.
     - `entity_supplemental_document` - A supplemental document associated an an
       Entity.

src/increase/types/file_create_params.py

@@ -68,10 +68,11 @@ class FileCreateParams(TypedDict, total=False):
     - `digital_wallet_app_icon` - An icon for you app to be rendered inside digital
       wallet apps. This must be a 100x100 pixel PNG.
     - `physical_card_front` - A card image to be printed on the front of a physical
-      card. This must be a 2100x1344 pixel PNG with no other color but black.
+      card. This must be a 2100x1344 pixel PNG with a density of 600 dots per inch
+      (DPI) and no other color but black.
     - `physical_card_carrier` - An image representing the entirety of the carrier
-      used for a physical card. This must be a 2550x3300 pixel PNG with no other
-      color but black.
+      used for a physical card. This must be a 2550x3300 pixel PNG with a density of
+      300 dots per inch (DPI) and no other color but black.
     - `document_request` - A document requested by Increase.
     - `entity_supplemental_document` - A supplemental document associated an an
       Entity.

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/physical_card_profile_create_params.py

@@ -9,7 +9,11 @@
 
 class PhysicalCardProfileCreateParams(TypedDict, total=False):
     carrier_image_file_id: Required[str]
-    """The identifier of the File containing the physical card's carrier image."""
+    """The identifier of the File containing the physical card's carrier image.
+
+    This must have `purpose: physical_card_carrier` and be a 2550x3300 pixel PNG
+    with a density of 300 dots per inch (DPI).
+    """
 
     contact_phone: Required[str]
     """A phone number the user can contact to receive support for their card."""
@@ -18,7 +22,11 @@ class PhysicalCardProfileCreateParams(TypedDict, total=False):
     """A description you can use to identify the Card Profile."""
 
     front_image_file_id: Required[str]
-    """The identifier of the File containing the physical card's front image."""
+    """The identifier of the File containing the physical card's front image.
+
+    This must have `purpose: physical_card_front` and be a 2100x1344 pixel PNG with
+    a density of 600 dots per inch (DPI).
+    """
 
     program_id: Required[str]
     """The identifier for the Program that this Physical Card Profile falls under."""