# This file was auto-generated by Fern from our API Definition.

import datetime as dt
import typing

import pydantic
from ..core.pydantic_utilities import IS_PYDANTIC_V2
from ..core.unchecked_base_model import UncheckedBaseModel
from .order_id import OrderId
from .order_state import OrderState


class OrderSummary(UncheckedBaseModel):
    order_id: OrderId = pydantic.Field()
    """
    The ID of the order.
    """

    name: str = pydantic.Field()
    """
    The display name of the order.
    """

    state: OrderState = pydantic.Field()
    """
    The current state of the order.
    """

    total_amount_usd: typing.Optional[float] = pydantic.Field(default=None)
    """
    The total price for all items in USD. Excluded from response until quotes are available.
    """

    sandbox: typing.Optional[bool] = pydantic.Field(default=None)
    """
    Whether this is a sandbox order that auto-progresses without producer intervention.
    """

    submitted_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
    """
    The timestamp when the order was submitted, if applicable.
    """

    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
    """
    The timestamp when the order was last modified, if applicable.
    """

    cancel_reason: typing.Optional[str] = pydantic.Field(default=None)
    """
    The reason the order was cancelled, if applicable.
    """

    if IS_PYDANTIC_V2:
        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
    else:

        class Config:
            frozen = True
            smart_union = True
            extra = pydantic.Extra.allow
