lockbox.py

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from typing import TYPE_CHECKING, Dict, Optional
from datetime import datetime
from typing_extensions import Literal

from pydantic import Field as FieldInfo

from .._models import BaseModel

__all__ = ["Lockbox", "Address"]


class Address(BaseModel):
    """The mailing address for the Lockbox."""

    city: str
    """The city of the address."""

    line1: str
    """The first line of the address."""

    line2: str
    """The second line of the address."""

    postal_code: str
    """The postal code of the address."""

    recipient: Optional[str] = None
    """The recipient line of the address.

    This will include the recipient name you provide when creating the address, as
    well as an ATTN suffix to help route the mail to your lockbox. Mail senders must
    include this ATTN line to receive mail at this Lockbox.
    """

    state: str
    """
    The two-letter United States Postal Service (USPS) abbreviation for the state of
    the address.
    """


class Lockbox(BaseModel):
    """Lockboxes are physical locations that can receive mail containing paper checks.

    Increase will automatically create a Check Deposit for checks received this way.
    """

    id: str
    """The Lockbox identifier."""

    account_id: str
    """
    The identifier for the Account checks sent to this lockbox will be deposited
    into.
    """

    address: Address
    """The mailing address for the Lockbox."""

    check_deposit_behavior: Literal["enabled", "disabled", "pend_for_processing"]
    """Indicates if checks mailed to this lockbox will be deposited.

    - `enabled` - Checks mailed to this Lockbox will be deposited.
    - `disabled` - Checks mailed to this Lockbox will not be deposited.
    - `pend_for_processing` - Checks mailed to this Lockbox will be pending until
      actioned.
    """

    created_at: datetime
    """
    The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
    was created.
    """

    description: Optional[str] = None
    """The description you choose for the Lockbox."""

    idempotency_key: Optional[str] = None
    """The idempotency key you chose for this object.

    This value is unique across Increase and is used to ensure that a request is
    only processed once. Learn more about
    [idempotency](https://increase.com/documentation/idempotency-keys).
    """

    recipient_name: Optional[str] = None
    """The recipient name you choose for the Lockbox."""

    type: Literal["lockbox"]
    """A constant representing the object's type.

    For this resource it will always be `lockbox`.
    """

    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]