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

import typing

import typing_extensions
from .customer_segment import CustomerSegmentParams
from .error import ErrorParams


class GetCustomerSegmentResponseParams(typing_extensions.TypedDict):
    """
    Defines the fields that are included in the response body for requests to the `RetrieveCustomerSegment` endpoint.

    Either `errors` or `segment` is present in a given response (never both).
    """

    errors: typing_extensions.NotRequired[typing.Sequence[ErrorParams]]
    """
    Any errors that occurred during the request.
    """

    segment: typing_extensions.NotRequired[CustomerSegmentParams]
    """
    The retrieved customer segment.
    """
