feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: 49d468466a752f8ea72af00d00683f50
+openapi_spec_hash: 0d9af58b9c33faa782f0c6a43a00b799
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

src/increase/resources/entities.py

@@ -49,13 +49,16 @@ def with_streaming_response(self) -> EntitiesResourceWithStreamingResponse:
     def create(
         self,
         *,
-        structure: Literal["corporation", "natural_person", "joint", "trust", "government_authority"],
+        structure: Literal[
+            "corporation", "natural_person", "joint", "trust", "government_authority", "sole_proprietorship"
+        ],
         corporation: entity_create_params.Corporation | Omit = omit,
         description: str | Omit = omit,
         government_authority: entity_create_params.GovernmentAuthority | Omit = omit,
         joint: entity_create_params.Joint | Omit = omit,
         natural_person: entity_create_params.NaturalPerson | Omit = omit,
         risk_rating: entity_create_params.RiskRating | Omit = omit,
+        sole_proprietorship: entity_create_params.SoleProprietorship | Omit = omit,
         supplemental_documents: Iterable[entity_create_params.SupplementalDocument] | Omit = omit,
         terms_agreements: Iterable[entity_create_params.TermsAgreement] | Omit = omit,
         third_party_verification: entity_create_params.ThirdPartyVerification | Omit = omit,
@@ -79,6 +82,7 @@ def create(
               - `joint` - Multiple individual people.
               - `trust` - A trust.
               - `government_authority` - A government authority.
+              - `sole_proprietorship` - A sole proprietorship.
 
           corporation: Details of the corporation entity to create. Required if `structure` is equal to
               `corporation`.
@@ -99,6 +103,9 @@ def create(
           risk_rating: An assessment of the entity's potential risk of involvement in financial crimes,
               such as money laundering.
 
+          sole_proprietorship: Details of the sole proprietorship entity to create. Required if `structure` is
+              equal to `sole_proprietorship`.
+
           supplemental_documents: Additional documentation associated with the entity.
 
           terms_agreements: The terms that the Entity agreed to. Not all programs are required to submit
@@ -132,6 +139,7 @@ def create(
                     "joint": joint,
                     "natural_person": natural_person,
                     "risk_rating": risk_rating,
+                    "sole_proprietorship": sole_proprietorship,
                     "supplemental_documents": supplemental_documents,
                     "terms_agreements": terms_agreements,
                     "third_party_verification": third_party_verification,
@@ -404,13 +412,16 @@ def with_streaming_response(self) -> AsyncEntitiesResourceWithStreamingResponse:
     async def create(
         self,
         *,
-        structure: Literal["corporation", "natural_person", "joint", "trust", "government_authority"],
+        structure: Literal[
+            "corporation", "natural_person", "joint", "trust", "government_authority", "sole_proprietorship"
+        ],
         corporation: entity_create_params.Corporation | Omit = omit,
         description: str | Omit = omit,
         government_authority: entity_create_params.GovernmentAuthority | Omit = omit,
         joint: entity_create_params.Joint | Omit = omit,
         natural_person: entity_create_params.NaturalPerson | Omit = omit,
         risk_rating: entity_create_params.RiskRating | Omit = omit,
+        sole_proprietorship: entity_create_params.SoleProprietorship | Omit = omit,
         supplemental_documents: Iterable[entity_create_params.SupplementalDocument] | Omit = omit,
         terms_agreements: Iterable[entity_create_params.TermsAgreement] | Omit = omit,
         third_party_verification: entity_create_params.ThirdPartyVerification | Omit = omit,
@@ -434,6 +445,7 @@ async def create(
               - `joint` - Multiple individual people.
               - `trust` - A trust.
               - `government_authority` - A government authority.
+              - `sole_proprietorship` - A sole proprietorship.
 
           corporation: Details of the corporation entity to create. Required if `structure` is equal to
               `corporation`.
@@ -454,6 +466,9 @@ async def create(
           risk_rating: An assessment of the entity's potential risk of involvement in financial crimes,
               such as money laundering.
 
+          sole_proprietorship: Details of the sole proprietorship entity to create. Required if `structure` is
+              equal to `sole_proprietorship`.
+
           supplemental_documents: Additional documentation associated with the entity.
 
           terms_agreements: The terms that the Entity agreed to. Not all programs are required to submit
@@ -487,6 +502,7 @@ async def create(
                     "joint": joint,
                     "natural_person": natural_person,
                     "risk_rating": risk_rating,
+                    "sole_proprietorship": sole_proprietorship,
                     "supplemental_documents": supplemental_documents,
                     "terms_agreements": terms_agreements,
                     "third_party_verification": third_party_verification,

src/increase/resources/simulations/programs.py

@@ -49,6 +49,7 @@ def create(
         name: str,
         bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank", "increase_bank"] | Omit = omit,
         lending_maximum_extendable_credit: int | Omit = omit,
+        loan_accounts_require_loan_offers: bool | Omit = omit,
         reserve_account_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -77,6 +78,9 @@ def create(
 
           lending_maximum_extendable_credit: The maximum extendable credit of the program being added.
 
+          loan_accounts_require_loan_offers: Whether opening a loan Account under this Program requires an accepted Loan
+              Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
+
           reserve_account_id: The identifier of the Account the Program should be added to is for.
 
           extra_headers: Send extra headers
@@ -96,6 +100,7 @@ def create(
                     "name": name,
                     "bank": bank,
                     "lending_maximum_extendable_credit": lending_maximum_extendable_credit,
+                    "loan_accounts_require_loan_offers": loan_accounts_require_loan_offers,
                     "reserve_account_id": reserve_account_id,
                 },
                 program_create_params.ProgramCreateParams,
@@ -137,6 +142,7 @@ async def create(
         name: str,
         bank: Literal["core_bank", "first_internet_bank", "grasshopper_bank", "increase_bank"] | Omit = omit,
         lending_maximum_extendable_credit: int | Omit = omit,
+        loan_accounts_require_loan_offers: bool | Omit = omit,
         reserve_account_id: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -165,6 +171,9 @@ async def create(
 
           lending_maximum_extendable_credit: The maximum extendable credit of the program being added.
 
+          loan_accounts_require_loan_offers: Whether opening a loan Account under this Program requires an accepted Loan
+              Offer. Requires `lending_maximum_extendable_credit`. Defaults to `false`.
+
           reserve_account_id: The identifier of the Account the Program should be added to is for.
 
           extra_headers: Send extra headers
@@ -184,6 +193,7 @@ async def create(
                     "name": name,
                     "bank": bank,
                     "lending_maximum_extendable_credit": lending_maximum_extendable_credit,
+                    "loan_accounts_require_loan_offers": loan_accounts_require_loan_offers,
                     "reserve_account_id": reserve_account_id,
                 },
                 program_create_params.ProgramCreateParams,

src/increase/types/card_dispute.py

@@ -2661,6 +2661,9 @@ class CardDispute(BaseModel):
     id: str
     """The Card Dispute identifier."""
 
+    account_id: str
+    """The Account that the Card Dispute is associated with."""
+
     amount: int
     """The amount of the dispute."""
 

src/increase/types/card_purchase_supplement.py

@@ -246,6 +246,9 @@ class CardPurchaseSupplement(BaseModel):
     id: str
     """The Card Purchase Supplement identifier."""
 
+    account_id: str
+    """The identifier for the Account the Card Purchase Supplement belongs to."""
+
     card_payment_id: Optional[str] = None
     """The ID of the Card Payment this transaction belongs to."""
 

src/increase/types/check_deposit.py

@@ -299,25 +299,24 @@ def __getattr__(self, attr: str) -> object: ...
 
 
 class DepositSubmission(BaseModel):
-    """After the check is parsed, it is submitted to the Check21 network for processing.
-
-    This will contain details of the submission.
+    """
+    After the check is parsed, it is submitted to the Check 21 network for processing. This will contain details of the submission.
     """
 
     back_file_id: str
     """
     The ID for the File containing the check back image that was submitted to the
-    Check21 network.
+    Check 21 network.
     """
 
     front_file_id: str
     """
     The ID for the File containing the check front image that was submitted to the
-    Check21 network.
+    Check 21 network.
     """
 
     submitted_at: datetime
-    """When the check deposit was submitted to the Check21 network for processing.
+    """When the check deposit was submitted to the Check 21 network for processing.
 
     During business days, this happens within a few hours of the check being
     accepted by Increase.
@@ -437,10 +436,9 @@ class CheckDeposit(BaseModel):
     """
 
     deposit_submission: Optional[DepositSubmission] = None
-    """After the check is parsed, it is submitted to the Check21 network for
-    processing.
-
-    This will contain details of the submission.
+    """
+    After the check is parsed, it is submitted to the Check 21 network for
+    processing. This will contain details of the submission.
     """
 
     description: Optional[str] = None

src/increase/types/check_transfer_create_params.py

@@ -218,7 +218,11 @@ class PhysicalCheck(TypedDict, total=False, extra_items=object):  # type: ignore
     """
 
     note: str
-    """The descriptor that will be printed on the letter included with the check."""
+    """A few paragraphs of text printed on the letter included with the check.
+
+    It can contain at most 22 lines. Paragraphs will wrap at about 120 characters,
+    but depending on your exact message, it might be slightly more or slightly less.
+    """
 
     physical_check_batch_id: str
     """The identifier of the Physical Check Batch to mail this check as a part of."""

src/increase/types/declined_transaction.py

@@ -1285,6 +1285,7 @@ class SourceInboundFednowTransferDecline(BaseModel):
         "group_locked",
         "entity_not_active",
         "fednow_not_enabled",
+        "transaction_not_allowed",
     ]
     """Why the transfer was declined.
 
@@ -1295,6 +1296,8 @@ class SourceInboundFednowTransferDecline(BaseModel):
     - `entity_not_active` - The account's entity is not active.
     - `fednow_not_enabled` - Your account is not enabled to receive FedNow
       transfers.
+    - `transaction_not_allowed` - The transaction is not allowed per Increase's
+      terms.
     """
 
     transfer_id: str

src/increase/types/digital_wallet_token.py

@@ -120,6 +120,9 @@ class DigitalWalletToken(BaseModel):
     id: str
     """The Digital Wallet Token identifier."""
 
+    account_id: str
+    """The identifier for the Account this Digital Wallet Token belongs to."""
+
     card_id: str
     """The identifier for the Card this Digital Wallet Token belongs to."""