# Shared

## Domain Types

### Chat Handle

- `class ChatHandle: …`

  - `id: str`

    Unique identifier for this handle

  - `handle: str`

    Phone number (E.164) or email address of the participant

  - `joined_at: datetime`

    When this participant joined the chat

  - `service: ServiceType`

    Messaging service type

    - `"iMessage"`

    - `"SMS"`

    - `"RCS"`

  - `is_me: Optional[bool]`

    Whether this handle belongs to the sender (your phone number)

  - `left_at: Optional[datetime]`

    When they left (if applicable)

  - `status: Optional[Literal["active", "left", "removed"]]`

    Participant status

    - `"active"`

    - `"left"`

    - `"removed"`

### Link Part Response

- `class LinkPartResponse: …`

  A rich link preview part

  - `reactions: Optional[List[Reaction]]`

    Reactions on this message part

    - `handle: ChatHandle`

      - `id: str`

        Unique identifier for this handle

      - `handle: str`

        Phone number (E.164) or email address of the participant

      - `joined_at: datetime`

        When this participant joined the chat

      - `service: ServiceType`

        Messaging service type

        - `"iMessage"`

        - `"SMS"`

        - `"RCS"`

      - `is_me: Optional[bool]`

        Whether this handle belongs to the sender (your phone number)

      - `left_at: Optional[datetime]`

        When they left (if applicable)

      - `status: Optional[Literal["active", "left", "removed"]]`

        Participant status

        - `"active"`

        - `"left"`

        - `"removed"`

    - `is_me: bool`

      Whether this reaction is from the current user

    - `type: ReactionType`

      Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
      Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
      Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

      - `"love"`

      - `"like"`

      - `"dislike"`

      - `"laugh"`

      - `"emphasize"`

      - `"question"`

      - `"custom"`

      - `"sticker"`

    - `custom_emoji: Optional[str]`

      Custom emoji if type is "custom", null otherwise

    - `sticker: Optional[Sticker]`

      Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

      - `file_name: Optional[str]`

        Filename of the sticker

      - `height: Optional[int]`

        Sticker image height in pixels

      - `mime_type: Optional[str]`

        MIME type of the sticker image

      - `url: Optional[str]`

        Presigned URL for downloading the sticker image (expires in 1 hour).

      - `width: Optional[int]`

        Sticker image width in pixels

  - `type: Literal["link"]`

    Indicates this is a rich link preview part

    - `"link"`

  - `value: str`

    The URL

### Media Part Response

- `class MediaPartResponse: …`

  A media attachment part

  - `id: str`

    Unique attachment identifier

  - `filename: str`

    Original filename

  - `mime_type: str`

    MIME type of the file

  - `reactions: Optional[List[Reaction]]`

    Reactions on this message part

    - `handle: ChatHandle`

      - `id: str`

        Unique identifier for this handle

      - `handle: str`

        Phone number (E.164) or email address of the participant

      - `joined_at: datetime`

        When this participant joined the chat

      - `service: ServiceType`

        Messaging service type

        - `"iMessage"`

        - `"SMS"`

        - `"RCS"`

      - `is_me: Optional[bool]`

        Whether this handle belongs to the sender (your phone number)

      - `left_at: Optional[datetime]`

        When they left (if applicable)

      - `status: Optional[Literal["active", "left", "removed"]]`

        Participant status

        - `"active"`

        - `"left"`

        - `"removed"`

    - `is_me: bool`

      Whether this reaction is from the current user

    - `type: ReactionType`

      Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
      Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
      Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

      - `"love"`

      - `"like"`

      - `"dislike"`

      - `"laugh"`

      - `"emphasize"`

      - `"question"`

      - `"custom"`

      - `"sticker"`

    - `custom_emoji: Optional[str]`

      Custom emoji if type is "custom", null otherwise

    - `sticker: Optional[Sticker]`

      Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

      - `file_name: Optional[str]`

        Filename of the sticker

      - `height: Optional[int]`

        Sticker image height in pixels

      - `mime_type: Optional[str]`

        MIME type of the sticker image

      - `url: Optional[str]`

        Presigned URL for downloading the sticker image (expires in 1 hour).

      - `width: Optional[int]`

        Sticker image width in pixels

  - `size_bytes: int`

    File size in bytes

  - `type: Literal["media"]`

    Indicates this is a media attachment part

    - `"media"`

  - `url: str`

    Presigned URL for downloading the attachment (expires in 1 hour).

### Reaction

- `class Reaction: …`

  - `handle: ChatHandle`

    - `id: str`

      Unique identifier for this handle

    - `handle: str`

      Phone number (E.164) or email address of the participant

    - `joined_at: datetime`

      When this participant joined the chat

    - `service: ServiceType`

      Messaging service type

      - `"iMessage"`

      - `"SMS"`

      - `"RCS"`

    - `is_me: Optional[bool]`

      Whether this handle belongs to the sender (your phone number)

    - `left_at: Optional[datetime]`

      When they left (if applicable)

    - `status: Optional[Literal["active", "left", "removed"]]`

      Participant status

      - `"active"`

      - `"left"`

      - `"removed"`

  - `is_me: bool`

    Whether this reaction is from the current user

  - `type: ReactionType`

    Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
    Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
    Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

    - `"love"`

    - `"like"`

    - `"dislike"`

    - `"laugh"`

    - `"emphasize"`

    - `"question"`

    - `"custom"`

    - `"sticker"`

  - `custom_emoji: Optional[str]`

    Custom emoji if type is "custom", null otherwise

  - `sticker: Optional[Sticker]`

    Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

    - `file_name: Optional[str]`

      Filename of the sticker

    - `height: Optional[int]`

      Sticker image height in pixels

    - `mime_type: Optional[str]`

      MIME type of the sticker image

    - `url: Optional[str]`

      Presigned URL for downloading the sticker image (expires in 1 hour).

    - `width: Optional[int]`

      Sticker image width in pixels

### Reaction Type

- `Literal["love", "like", "dislike", 5 more]`

  Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
  Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
  Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

  - `"love"`

  - `"like"`

  - `"dislike"`

  - `"laugh"`

  - `"emphasize"`

  - `"question"`

  - `"custom"`

  - `"sticker"`

### Service Type

- `Literal["iMessage", "SMS", "RCS"]`

  Messaging service type

  - `"iMessage"`

  - `"SMS"`

  - `"RCS"`

### Text Decoration

- `class TextDecoration: …`

  - `range: List[int]`

    Character range `[start, end)` in the `value` string where the decoration applies.
    `start` is inclusive, `end` is exclusive.
    *Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.*

  - `animation: Optional[Literal["big", "small", "shake", 5 more]]`

    Animated text effect to apply. Mutually exclusive with `style`.

    - `"big"`

    - `"small"`

    - `"shake"`

    - `"nod"`

    - `"explode"`

    - `"ripple"`

    - `"bloom"`

    - `"jitter"`

  - `style: Optional[Literal["bold", "italic", "strikethrough", "underline"]]`

    Text style to apply. Mutually exclusive with `animation`.

    - `"bold"`

    - `"italic"`

    - `"strikethrough"`

    - `"underline"`

### Text Part Response

- `class TextPartResponse: …`

  A text message part

  - `reactions: Optional[List[Reaction]]`

    Reactions on this message part

    - `handle: ChatHandle`

      - `id: str`

        Unique identifier for this handle

      - `handle: str`

        Phone number (E.164) or email address of the participant

      - `joined_at: datetime`

        When this participant joined the chat

      - `service: ServiceType`

        Messaging service type

        - `"iMessage"`

        - `"SMS"`

        - `"RCS"`

      - `is_me: Optional[bool]`

        Whether this handle belongs to the sender (your phone number)

      - `left_at: Optional[datetime]`

        When they left (if applicable)

      - `status: Optional[Literal["active", "left", "removed"]]`

        Participant status

        - `"active"`

        - `"left"`

        - `"removed"`

    - `is_me: bool`

      Whether this reaction is from the current user

    - `type: ReactionType`

      Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question.
      Custom emoji reactions have type "custom" with the actual emoji in the custom_emoji field.
      Sticker reactions have type "sticker" with sticker attachment details in the sticker field.

      - `"love"`

      - `"like"`

      - `"dislike"`

      - `"laugh"`

      - `"emphasize"`

      - `"question"`

      - `"custom"`

      - `"sticker"`

    - `custom_emoji: Optional[str]`

      Custom emoji if type is "custom", null otherwise

    - `sticker: Optional[Sticker]`

      Sticker attachment details when reaction_type is "sticker". Null for non-sticker reactions.

      - `file_name: Optional[str]`

        Filename of the sticker

      - `height: Optional[int]`

        Sticker image height in pixels

      - `mime_type: Optional[str]`

        MIME type of the sticker image

      - `url: Optional[str]`

        Presigned URL for downloading the sticker image (expires in 1 hour).

      - `width: Optional[int]`

        Sticker image width in pixels

  - `type: Literal["text"]`

    Indicates this is a text message part

    - `"text"`

  - `value: str`

    The text content

  - `text_decorations: Optional[List[TextDecoration]]`

    Text decorations applied to character ranges in the value

    - `range: List[int]`

      Character range `[start, end)` in the `value` string where the decoration applies.
      `start` is inclusive, `end` is exclusive.
      *Characters are measured as UTF-16 code units. Most characters count as 1; some emoji count as 2.*

    - `animation: Optional[Literal["big", "small", "shake", 5 more]]`

      Animated text effect to apply. Mutually exclusive with `style`.

      - `"big"`

      - `"small"`

      - `"shake"`

      - `"nod"`

      - `"explode"`

      - `"ripple"`

      - `"bloom"`

      - `"jitter"`

    - `style: Optional[Literal["bold", "italic", "strikethrough", "underline"]]`

      Text style to apply. Mutually exclusive with `animation`.

      - `"bold"`

      - `"italic"`

      - `"strikethrough"`

      - `"underline"`