card.py

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

from typing import Optional
from datetime import datetime
from typing_extensions import Literal

from .._models import BaseModel

__all__ = ["Card", "BillingAddress", "DigitalWallet"]


class BillingAddress(BaseModel):
    city: Optional[str] = None
    """The city of the billing address."""

    line1: Optional[str] = None
    """The first line of the billing address."""

    line2: Optional[str] = None
    """The second line of the billing address."""

    postal_code: Optional[str] = None
    """The postal code of the billing address."""

    state: Optional[str] = None
    """The US state of the billing address."""


class DigitalWallet(BaseModel):
    digital_card_profile_id: Optional[str] = None
    """The digital card profile assigned to this digital card.

    Card profiles may also be assigned at the program level.
    """

    email: Optional[str] = None
    """
    An email address that can be used to verify the cardholder via one-time passcode
    over email.
    """

    phone: Optional[str] = None
    """
    A phone number that can be used to verify the cardholder via one-time passcode
    over SMS.
    """


class Card(BaseModel):
    id: str
    """The card identifier."""

    account_id: str
    """The identifier for the account this card belongs to."""

    billing_address: BillingAddress
    """The Card's billing address."""

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

    description: Optional[str] = None
    """The card's description for display purposes."""

    digital_wallet: Optional[DigitalWallet] = None
    """
    The contact information used in the two-factor steps for digital wallet card
    creation. At least one field must be present to complete the digital wallet
    steps.
    """

    entity_id: Optional[str] = None
    """The identifier for the entity associated with this card."""

    expiration_month: int
    """The month the card expires in M format (e.g., August is 8)."""

    expiration_year: int
    """The year the card expires in YYYY format (e.g., 2025)."""

    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).
    """

    last4: str
    """The last 4 digits of the Card's Primary Account Number."""

    status: Literal["active", "disabled", "canceled"]
    """This indicates if payments can be made with the card.

    - `active` - The card is active.
    - `disabled` - The card is temporarily disabled.
    - `canceled` - The card is permanently canceled.
    """

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

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