feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: 49d468466a752f8ea72af00d00683f50
+openapi_spec_hash: 15bc6c08330309f7232c5377af693d8d
 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_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/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."""
 

src/increase/types/entity_create_params.py

@@ -37,6 +37,11 @@
     "NaturalPersonIdentificationOther",
     "NaturalPersonIdentificationPassport",
     "RiskRating",
+    "SoleProprietorship",
+    "SoleProprietorshipAddress",
+    "SoleProprietorshipSoleProprietor",
+    "SoleProprietorshipSoleProprietorAddress",
+    "SoleProprietorshipSoleProprietorIdentification",
     "SupplementalDocument",
     "TermsAgreement",
     "ThirdPartyVerification",
@@ -59,14 +64,17 @@
 
 
 class EntityCreateParams(TypedDict, total=False):
-    structure: Required[Literal["corporation", "natural_person", "joint", "trust", "government_authority"]]
+    structure: Required[
+        Literal["corporation", "natural_person", "joint", "trust", "government_authority", "sole_proprietorship"]
+    ]
     """The type of Entity to create.
 
     - `corporation` - A corporation.
     - `natural_person` - An individual person.
     - `joint` - Multiple individual people.
     - `trust` - A trust.
     - `government_authority` - A government authority.
+    - `sole_proprietorship` - A sole proprietorship.
     """
 
     corporation: Corporation
@@ -104,6 +112,12 @@ class EntityCreateParams(TypedDict, total=False):
     such as money laundering.
     """
 
+    sole_proprietorship: SoleProprietorship
+    """Details of the sole proprietorship entity to create.
+
+    Required if `structure` is equal to `sole_proprietorship`.
+    """
+
     supplemental_documents: Iterable[SupplementalDocument]
     """Additional documentation associated with the entity."""
 
@@ -897,6 +911,157 @@ class RiskRating(TypedDict, total=False):
     """
 
 
+class SoleProprietorshipAddress(TypedDict, total=False):
+    """The sole proprietorship's business address.
+
+    Mail receiving locations like PO Boxes and PMB's are disallowed.
+    """
+
+    city: Required[str]
+    """The city of the address."""
+
+    line1: Required[str]
+    """The first line of the address. This is usually the street number and street."""
+
+    state: Required[str]
+    """
+    The two-letter United States Postal Service (USPS) abbreviation for the state of
+    the address.
+    """
+
+    zip: Required[str]
+    """The ZIP code of the address."""
+
+    line2: str
+    """The second line of the address. This might be the floor or room number."""
+
+
+class SoleProprietorshipSoleProprietorAddress(TypedDict, total=False):
+    """The individual's physical address.
+
+    Mail receiving locations like PO Boxes and PMB's are disallowed.
+    """
+
+    city: Required[str]
+    """The city, district, town, or village of the address."""
+
+    country: Required[str]
+    """The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+
+    Defaults to `US`.
+    """
+
+    line1: Required[str]
+    """The first line of the address. This is usually the street number and street."""
+
+    line2: str
+    """The second line of the address. This might be the floor or room number."""
+
+    state: str
+    """
+    The two-letter United States Postal Service (USPS) abbreviation for the US
+    state, province, or region of the address. Required in certain countries.
+    """
+
+    zip: str
+    """The ZIP or postal code of the address. Required in certain countries."""
+
+
+class SoleProprietorshipSoleProprietorIdentification(TypedDict, total=False):
+    """A means of verifying the person's identity.
+
+    Sole proprietors must be identified with a `social_security_number` or an `individual_taxpayer_identification_number`.
+    """
+
+    method: Required[Literal["social_security_number", "individual_taxpayer_identification_number"]]
+    """A method that can be used to verify the individual's identity.
+
+    - `social_security_number` - A social security number.
+    - `individual_taxpayer_identification_number` - An individual taxpayer
+      identification number (ITIN).
+    """
+
+    number: Required[str]
+    """
+    An identification number that can be used to verify the individual's identity,
+    such as a social security number. Submit nine digits with no dashes or other
+    separators. When testing in sandbox, use one of our
+    [sandbox test values](https://increase.com/documentation/sandbox-test-values).
+    """
+
+
+class SoleProprietorshipSoleProprietor(TypedDict, total=False):
+    """The individual who operates the sole proprietorship."""
+
+    address: Required[SoleProprietorshipSoleProprietorAddress]
+    """The individual's physical address.
+
+    Mail receiving locations like PO Boxes and PMB's are disallowed.
+    """
+
+    date_of_birth: Required[Annotated[Union[str, date], PropertyInfo(format="iso8601")]]
+    """The person's date of birth in YYYY-MM-DD format."""
+
+    identification: Required[SoleProprietorshipSoleProprietorIdentification]
+    """A means of verifying the person's identity.
+
+    Sole proprietors must be identified with a `social_security_number` or an
+    `individual_taxpayer_identification_number`.
+    """
+
+    name: Required[str]
+    """The person's legal name."""
+
+
+class SoleProprietorship(TypedDict, total=False):
+    """Details of the sole proprietorship entity to create.
+
+    Required if `structure` is equal to `sole_proprietorship`.
+    """
+
+    address: Required[SoleProprietorshipAddress]
+    """The sole proprietorship's business address.
+
+    Mail receiving locations like PO Boxes and PMB's are disallowed.
+    """
+
+    sole_proprietor: Required[SoleProprietorshipSoleProprietor]
+    """The individual who operates the sole proprietorship."""
+
+    doing_business_as_name: str
+    """
+    The name under which the sole proprietorship does business, if it is different
+    from the name of the sole proprietor.
+    """
+
+    email: str
+    """An email address for the sole proprietorship.
+
+    Not every program requires an email for submitted Entities.
+    """
+
+    industry_code: str
+    """
+    The North American Industry Classification System (NAICS) code for the sole
+    proprietorship's primary line of business. This is a number, like `5132` for
+    `Software Publishers`. A full list of classification codes is available
+    [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
+    """
+
+    tax_identifier: str
+    """
+    The United States Employer Identification Number (EIN) for the sole
+    proprietorship, if the sole proprietor has one. Submit nine digits with no
+    dashes or other separators.
+    """
+
+    website: str
+    """A website for the sole proprietorship.
+
+    Not every program requires a website for submitted Entities.
+    """
+
+
 class SupplementalDocument(TypedDict, total=False):
     file_id: Required[str]
     """The identifier of the File containing the document."""