chore: add missing docstrings

Author: stainless-app[bot]

src/increase/types/account.py

@@ -12,6 +12,11 @@
 
 
 class Account(BaseModel):
+    """Accounts are your bank accounts with Increase.
+
+    They store money, receive transfers, and send payments. They earn interest and have depository insurance.
+    """
+
     id: str
     """The Account identifier."""
 

src/increase/types/account_number.py

@@ -12,6 +12,8 @@
 
 
 class InboundACH(BaseModel):
+    """Properties related to how this Account Number handles inbound ACH transfers."""
+
     debit_status: Literal["allowed", "blocked"]
     """Whether ACH debits are allowed against this Account Number.
 
@@ -24,6 +26,10 @@ class InboundACH(BaseModel):
 
 
 class InboundChecks(BaseModel):
+    """
+    Properties related to how this Account Number should handle inbound check withdrawals.
+    """
+
     status: Literal["allowed", "check_transfers_only"]
     """How Increase should process checks with this account number printed on them.
 
@@ -35,6 +41,11 @@ class InboundChecks(BaseModel):
 
 
 class AccountNumber(BaseModel):
+    """Each account can have multiple account and routing numbers.
+
+    We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.
+    """
+
     id: str
     """The Account Number identifier."""
 

src/increase/types/account_number_create_params.py

@@ -25,6 +25,8 @@ class AccountNumberCreateParams(TypedDict, total=False):
 
 
 class InboundACH(TypedDict, total=False):
+    """Options related to how this Account Number should handle inbound ACH transfers."""
+
     debit_status: Required[Literal["allowed", "blocked"]]
     """Whether ACH debits are allowed against this Account Number.
 
@@ -38,6 +40,10 @@ class InboundACH(TypedDict, total=False):
 
 
 class InboundChecks(TypedDict, total=False):
+    """
+    Options related to how this Account Number should handle inbound check withdrawals.
+    """
+
     status: Required[Literal["allowed", "check_transfers_only"]]
     """How Increase should process checks with this account number printed on them.
 

src/increase/types/account_number_update_params.py

@@ -30,6 +30,8 @@ class AccountNumberUpdateParams(TypedDict, total=False):
 
 
 class InboundACH(TypedDict, total=False):
+    """Options related to how this Account Number handles inbound ACH transfers."""
+
     debit_status: Literal["allowed", "blocked"]
     """Whether ACH debits are allowed against this Account Number.
 
@@ -42,6 +44,10 @@ class InboundACH(TypedDict, total=False):
 
 
 class InboundChecks(TypedDict, total=False):
+    """
+    Options related to how this Account Number should handle inbound check withdrawals.
+    """
+
     status: Required[Literal["allowed", "check_transfers_only"]]
     """How Increase should process checks with this account number printed on them.
 

src/increase/types/account_statement.py

@@ -9,6 +9,11 @@
 
 
 class AccountStatement(BaseModel):
+    """Account Statements are generated monthly for every active Account.
+
+    You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
+    """
+
     id: str
     """The Account Statement identifier."""
 

src/increase/types/account_transfer.py

@@ -20,6 +20,10 @@
 
 
 class Approval(BaseModel):
+    """
+    If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
+    """
+
     approved_at: datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -34,6 +38,10 @@ class Approval(BaseModel):
 
 
 class Cancellation(BaseModel):
+    """
+    If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
+    """
+
     canceled_at: datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -48,21 +56,29 @@ class Cancellation(BaseModel):
 
 
 class CreatedByAPIKey(BaseModel):
+    """If present, details about the API key that created the transfer."""
+
     description: Optional[str] = None
     """The description set for the API key when it was created."""
 
 
 class CreatedByOAuthApplication(BaseModel):
+    """If present, details about the OAuth Application that created the transfer."""
+
     name: str
     """The name of the OAuth Application."""
 
 
 class CreatedByUser(BaseModel):
+    """If present, details about the User that created the transfer."""
+
     email: str
     """The email address of the User."""
 
 
 class CreatedBy(BaseModel):
+    """What object created the transfer, either via the API or the dashboard."""
+
     api_key: Optional[CreatedByAPIKey] = None
     """If present, details about the API key that created the transfer."""
 
@@ -84,6 +100,10 @@ class CreatedBy(BaseModel):
 
 
 class AccountTransfer(BaseModel):
+    """
+    Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).
+    """
+
     id: str
     """The Account Transfer's identifier."""
 

src/increase/types/ach_prenotification.py

@@ -88,6 +88,8 @@ class NotificationsOfChange(BaseModel):
 
 
 class PrenotificationReturn(BaseModel):
+    """If your prenotification is returned, this will contain details of the return."""
+
     created_at: datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -319,6 +321,10 @@ class PrenotificationReturn(BaseModel):
 
 
 class ACHPrenotification(BaseModel):
+    """
+    ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
+    """
+
     id: str
     """The ACH Prenotification's identifier."""
 

src/increase/types/ach_transfer.py

@@ -32,6 +32,10 @@
 
 
 class Acknowledgement(BaseModel):
+    """
+    After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
+    """
+
     acknowledged_at: str
     """
     When the Federal Reserve acknowledged the submitted file containing this
@@ -45,6 +49,8 @@ class AddendaFreeformEntry(BaseModel):
 
 
 class AddendaFreeform(BaseModel):
+    """Unstructured `payment_related_information` passed through with the transfer."""
+
     entries: List[AddendaFreeformEntry]
     """Each entry represents an addendum sent with the transfer."""
 
@@ -61,11 +67,18 @@ class AddendaPaymentOrderRemittanceAdviceInvoice(BaseModel):
 
 
 class AddendaPaymentOrderRemittanceAdvice(BaseModel):
+    """Structured ASC X12 820 remittance advice records.
+
+    Please reach out to [support@increase.com](mailto:support@increase.com) for more information.
+    """
+
     invoices: List[AddendaPaymentOrderRemittanceAdviceInvoice]
     """ASC X12 RMR records for this specific transfer."""
 
 
 class Addenda(BaseModel):
+    """Additional information that will be sent to the recipient."""
+
     category: Literal["freeform", "payment_order_remittance_advice", "other"]
     """The type of the resource.
 
@@ -92,6 +105,10 @@ class Addenda(BaseModel):
 
 
 class Approval(BaseModel):
+    """
+    If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
+    """
+
     approved_at: datetime.datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -106,6 +123,10 @@ class Approval(BaseModel):
 
 
 class Cancellation(BaseModel):
+    """
+    If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
+    """
+
     canceled_at: datetime.datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -120,21 +141,29 @@ class Cancellation(BaseModel):
 
 
 class CreatedByAPIKey(BaseModel):
+    """If present, details about the API key that created the transfer."""
+
     description: Optional[str] = None
     """The description set for the API key when it was created."""
 
 
 class CreatedByOAuthApplication(BaseModel):
+    """If present, details about the OAuth Application that created the transfer."""
+
     name: str
     """The name of the OAuth Application."""
 
 
 class CreatedByUser(BaseModel):
+    """If present, details about the User that created the transfer."""
+
     email: str
     """The email address of the User."""
 
 
 class CreatedBy(BaseModel):
+    """What object created the transfer, either via the API or the dashboard."""
+
     api_key: Optional[CreatedByAPIKey] = None
     """If present, details about the API key that created the transfer."""
 
@@ -156,6 +185,11 @@ class CreatedBy(BaseModel):
 
 
 class InboundFundsHold(BaseModel):
+    """Increase will sometimes hold the funds for ACH debit transfers.
+
+    If funds are held, this sub-object will contain details of the hold.
+    """
+
     amount: int
     """The held amount in the minor unit of the account's currency.
 
@@ -296,6 +330,11 @@ class NotificationsOfChange(BaseModel):
 
 
 class PreferredEffectiveDate(BaseModel):
+    """Configuration for how the effective date of the transfer will be set.
+
+    This determines same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.
+    """
+
     date: Optional[datetime.date] = None
     """
     A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to
@@ -316,6 +355,8 @@ class PreferredEffectiveDate(BaseModel):
 
 
 class Return(BaseModel):
+    """If your transfer is returned, this will contain details of the return."""
+
     created_at: datetime.datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
@@ -578,6 +619,10 @@ def __getattr__(self, attr: str) -> object: ...
 
 
 class Settlement(BaseModel):
+    """
+    A subhash containing information about when and how the transfer settled at the Federal Reserve.
+    """
+
     settled_at: datetime.datetime
     """
     When the funds for this transfer have settled at the destination bank at the
@@ -586,6 +631,10 @@ class Settlement(BaseModel):
 
 
 class Submission(BaseModel):
+    """
+    After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
+    """
+
     administrative_returns_expected_by: datetime.datetime
     """The timestamp by which any administrative returns are expected to be received
     by.
@@ -637,6 +686,10 @@ class Submission(BaseModel):
 
 
 class ACHTransfer(BaseModel):
+    """
+    ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
+    """
+
     id: str
     """The ACH transfer's identifier."""
 

src/increase/types/ach_transfer_create_params.py

@@ -155,6 +155,11 @@ class AddendaFreeformEntry(TypedDict, total=False):
 
 
 class AddendaFreeform(TypedDict, total=False):
+    """Unstructured `payment_related_information` passed through with the transfer.
+
+    Required if and only if `category` is `freeform`.
+    """
+
     entries: Required[Iterable[AddendaFreeformEntry]]
     """Each entry represents an addendum sent with the transfer.
 
@@ -177,11 +182,21 @@ class AddendaPaymentOrderRemittanceAdviceInvoice(TypedDict, total=False):
 
 
 class AddendaPaymentOrderRemittanceAdvice(TypedDict, total=False):
+    """Structured ASC X12 820 remittance advice records.
+
+    Please reach out to [support@increase.com](mailto:support@increase.com) for more information. Required if and only if `category` is `payment_order_remittance_advice`.
+    """
+
     invoices: Required[Iterable[AddendaPaymentOrderRemittanceAdviceInvoice]]
     """ASC X12 RMR records for this specific transfer."""
 
 
 class Addenda(TypedDict, total=False):
+    """Additional information that will be sent to the recipient.
+
+    This is included in the transfer data sent to the receiving bank.
+    """
+
     category: Required[Literal["freeform", "payment_order_remittance_advice"]]
     """The type of addenda to pass with the transfer.
 
@@ -208,6 +223,11 @@ class Addenda(TypedDict, total=False):
 
 
 class PreferredEffectiveDate(TypedDict, total=False):
+    """Configuration for how the effective date of the transfer will be set.
+
+    This determines same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set.
+    """
+
     date: Annotated[Union[str, datetime.date], PropertyInfo(format="iso8601")]
     """
     A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to

src/increase/types/balance_lookup.py

@@ -8,6 +8,10 @@
 
 
 class BalanceLookup(BaseModel):
+    """
+    Represents a request to lookup the balance of an Account at a given point in time.
+    """
+
     account_id: str
     """The identifier for the account for which the balance was queried."""