linq-python 0.13.0__tar.gz → 0.15.0__tar.gz

linq_python-0.15.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.15.0"
+}

linq_python-0.15.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [0.15.0](https://github.com/linq-team/linq-python/compare/v0.14.0...v0.15.0) (2026-06-21)
+
+
+### Features
+
+* phone line reputation + group chat icon; remove iMessage app image layout & session_id ([#32](https://github.com/linq-team/linq-python/issues/32)) ([736fe20](https://github.com/linq-team/linq-python/commit/736fe201b71b3c3bf88c5621621a0a5fbee4ac56))
+
+## [0.14.0](https://github.com/linq-team/linq-python/compare/v0.13.0...v0.14.0) (2026-06-10)
+
+
+### Features
+
+* regenerate SDKs from updated API spec ([#29](https://github.com/linq-team/linq-python/issues/29)) ([dd7f2d7](https://github.com/linq-team/linq-python/commit/dd7f2d7e19e85fa9f61f6367f7e2a1cc942765bf))
+
+
+### Bug Fixes
+
+* **ci:** parse release PR number in shell, not fromJSON in env ([#26](https://github.com/linq-team/linq-python/issues/26)) ([a364403](https://github.com/linq-team/linq-python/commit/a364403289e482298f8b0d78e8e45de8fb87b79d))

{linq_python-0.13.0 → linq_python-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: linq-python
-Version: 0.13.0
+Version: 0.15.0
 Summary: The official Python library for the linq-api-v3 API
 Project-URL: Homepage, https://github.com/linq-team/linq-python
 Project-URL: Repository, https://github.com/linq-team/linq-python

{linq_python-0.13.0 → linq_python-0.15.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "linq-python"
-version = "0.13.0"
+version = "0.15.0"
 description = "The official Python library for the linq-api-v3 API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "linq"
-__version__ = "0.13.0"  # x-release-please-version
+__version__ = "0.15.0"  # x-release-please-version

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/resources/capability.py

@@ -82,7 +82,7 @@ class CapabilityResource(SyncAPIResource):
                     "address": address,
                     "from_": from_,
                 },
-                capability_check_i_message_params.CapabilityCheckiMessageParams,
+                capability_check_i_message_params.CapabilityCheckIMessageParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -196,7 +196,7 @@ class AsyncCapabilityResource(AsyncAPIResource):
                     "address": address,
                     "from_": from_,
                 },
-                capability_check_i_message_params.CapabilityCheckiMessageParams,
+                capability_check_i_message_params.CapabilityCheckIMessageParams,
             ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/__init__.py

@@ -65,7 +65,7 @@ from .message_received_webhook_event import MessageReceivedWebhookEvent as Messa
 from .reaction_removed_webhook_event import ReactionRemovedWebhookEvent as ReactionRemovedWebhookEvent
 from .message_delivered_webhook_event import MessageDeliveredWebhookEvent as MessageDeliveredWebhookEvent
 from .participant_added_webhook_event import ParticipantAddedWebhookEvent as ParticipantAddedWebhookEvent
-from .capability_check_i_message_params import CapabilityCheckiMessageParams as CapabilityCheckiMessageParams
+from .capability_check_i_message_params import CapabilityCheckIMessageParams as CapabilityCheckIMessageParams
 from .participant_removed_webhook_event import ParticipantRemovedWebhookEvent as ParticipantRemovedWebhookEvent
 from .webhook_subscription_create_params import WebhookSubscriptionCreateParams as WebhookSubscriptionCreateParams
 from .webhook_subscription_list_response import WebhookSubscriptionListResponse as WebhookSubscriptionListResponse

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/capability_check_i_message_params.py

@@ -6,10 +6,10 @@ from typing_extensions import Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
-__all__ = ["CapabilityCheckiMessageParams"]
+__all__ = ["CapabilityCheckIMessageParams"]
 
 
-class CapabilityCheckiMessageParams(TypedDict, total=False):
+class CapabilityCheckIMessageParams(TypedDict, total=False):
     address: Required[str]
     """The recipient phone number or email address to check"""
 

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/chat.py

@@ -83,5 +83,11 @@ class Chat(BaseModel):
     updated_at: datetime
     """When the chat was last updated"""
 
+    group_chat_icon: Optional[str] = None
+    """URL of the group chat icon.
+
+    Only set for group chats that have an icon; `null` otherwise.
+    """
+
     service: Optional[ServiceType] = None
     """Messaging service type"""

linq_python-0.15.0/src/linq/types/chats/sent_message.py

@@ -0,0 +1,139 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+from ..reply_to import ReplyTo
+from ..message_effect import MessageEffect
+from ..shared.reaction import Reaction
+from ..shared.chat_handle import ChatHandle
+from ..shared.service_type import ServiceType
+from ..shared.link_part_response import LinkPartResponse
+from ..shared.text_part_response import TextPartResponse
+from ..shared.media_part_response import MediaPartResponse
+
+__all__ = [
+    "SentMessage",
+    "Part",
+    "PartIMessageAppPartResponse",
+    "PartIMessageAppPartResponseApp",
+    "PartIMessageAppPartResponseLayout",
+]
+
+
+class PartIMessageAppPartResponseApp(BaseModel):
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    bundle_id: str
+    """Bundle identifier of the Messages app extension. Must not contain `:`."""
+
+    name: str
+    """Display name of the app, shown by Messages' fallback UI."""
+
+    team_id: str
+    """The app's 10-character uppercase alphanumeric team identifier."""
+
+    app_store_id: Optional[int] = None
+    """The owning app's App Store id (optional).
+
+    When set, recipients without the iMessage app installed see a "Get the app"
+    affordance.
+    """
+
+
+class PartIMessageAppPartResponseLayout(BaseModel):
+    """Visible layout of the card.
+
+    At least one of
+    `caption`, `subcaption`, `trailing_caption`, or `trailing_subcaption` must be set, otherwise
+    the card renders as an empty bubble. Any image on the card is drawn by the recipient's
+    installed app extension; it cannot be supplied here.
+    """
+
+    caption: Optional[str] = None
+    """Primary label, top-left and bold."""
+
+    subcaption: Optional[str] = None
+    """Secondary label, below `caption` on the left."""
+
+    trailing_caption: Optional[str] = None
+    """Label shown top-right."""
+
+    trailing_subcaption: Optional[str] = None
+    """Label shown below `trailing_caption`, on the right."""
+
+
+class PartIMessageAppPartResponse(BaseModel):
+    """An iMessage app card part."""
+
+    app: PartIMessageAppPartResponseApp
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    layout: PartIMessageAppPartResponseLayout
+    """Visible layout of the card.
+
+    At least one of `caption`, `subcaption`, `trailing_caption`, or
+    `trailing_subcaption` must be set, otherwise the card renders as an empty
+    bubble. Any image on the card is drawn by the recipient's installed app
+    extension; it cannot be supplied here.
+    """
+
+    reactions: Optional[List[Reaction]] = None
+    """Reactions on this message part"""
+
+    type: Literal["imessage_app"]
+    """Indicates this is an iMessage app card part."""
+
+    url: str
+    """The URL delivered to the iMessage app on tap."""
+
+    fallback_text: Optional[str] = None
+    """Fallback text for surfaces that cannot render the card."""
+
+
+Part: TypeAlias = Union[TextPartResponse, MediaPartResponse, LinkPartResponse, PartIMessageAppPartResponse]
+
+
+class SentMessage(BaseModel):
+    """A message that was sent (used in CreateChat and SendMessage responses)"""
+
+    id: str
+    """Message identifier (UUID)"""
+
+    created_at: datetime
+    """When the message was created"""
+
+    delivery_status: Literal["pending", "queued", "sent", "delivered", "received", "read", "failed"]
+    """Current delivery status of a message"""
+
+    is_read: bool
+    """DEPRECATED: Use `delivery_status == "read"` instead.
+
+    Whether the message has been read.
+    """
+
+    parts: List[Part]
+    """Message parts in order (text, media, and link)"""
+
+    sent_at: Optional[datetime] = None
+    """When the message was actually sent (null if still queued)"""
+
+    delivered_at: Optional[datetime] = None
+    """When the message was delivered"""
+
+    effect: Optional[MessageEffect] = None
+    """iMessage effect applied to a message (screen or bubble effect)"""
+
+    from_handle: Optional[ChatHandle] = None
+    """The sender of this message as a full handle object"""
+
+    preferred_service: Optional[ServiceType] = None
+    """Messaging service type"""
+
+    reply_to: Optional[ReplyTo] = None
+    """Indicates this message is a threaded reply to another message"""
+
+    service: Optional[ServiceType] = None
+    """Messaging service type"""

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/message.py

@@ -9,15 +9,93 @@ from pydantic import Field as FieldInfo
 from .._models import BaseModel
 from .reply_to import ReplyTo
 from .message_effect import MessageEffect
+from .shared.reaction import Reaction
 from .shared.chat_handle import ChatHandle
 from .shared.service_type import ServiceType
 from .shared.link_part_response import LinkPartResponse
 from .shared.text_part_response import TextPartResponse
 from .shared.media_part_response import MediaPartResponse
 
-__all__ = ["Message", "Part"]
+__all__ = [
+    "Message",
+    "Part",
+    "PartIMessageAppPartResponse",
+    "PartIMessageAppPartResponseApp",
+    "PartIMessageAppPartResponseLayout",
+]
 
-Part: TypeAlias = Union[TextPartResponse, MediaPartResponse, LinkPartResponse]
+
+class PartIMessageAppPartResponseApp(BaseModel):
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    bundle_id: str
+    """Bundle identifier of the Messages app extension. Must not contain `:`."""
+
+    name: str
+    """Display name of the app, shown by Messages' fallback UI."""
+
+    team_id: str
+    """The app's 10-character uppercase alphanumeric team identifier."""
+
+    app_store_id: Optional[int] = None
+    """The owning app's App Store id (optional).
+
+    When set, recipients without the iMessage app installed see a "Get the app"
+    affordance.
+    """
+
+
+class PartIMessageAppPartResponseLayout(BaseModel):
+    """Visible layout of the card.
+
+    At least one of
+    `caption`, `subcaption`, `trailing_caption`, or `trailing_subcaption` must be set, otherwise
+    the card renders as an empty bubble. Any image on the card is drawn by the recipient's
+    installed app extension; it cannot be supplied here.
+    """
+
+    caption: Optional[str] = None
+    """Primary label, top-left and bold."""
+
+    subcaption: Optional[str] = None
+    """Secondary label, below `caption` on the left."""
+
+    trailing_caption: Optional[str] = None
+    """Label shown top-right."""
+
+    trailing_subcaption: Optional[str] = None
+    """Label shown below `trailing_caption`, on the right."""
+
+
+class PartIMessageAppPartResponse(BaseModel):
+    """An iMessage app card part."""
+
+    app: PartIMessageAppPartResponseApp
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    layout: PartIMessageAppPartResponseLayout
+    """Visible layout of the card.
+
+    At least one of `caption`, `subcaption`, `trailing_caption`, or
+    `trailing_subcaption` must be set, otherwise the card renders as an empty
+    bubble. Any image on the card is drawn by the recipient's installed app
+    extension; it cannot be supplied here.
+    """
+
+    reactions: Optional[List[Reaction]] = None
+    """Reactions on this message part"""
+
+    type: Literal["imessage_app"]
+    """Indicates this is an iMessage app card part."""
+
+    url: str
+    """The URL delivered to the iMessage app on tap."""
+
+    fallback_text: Optional[str] = None
+    """Fallback text for surfaces that cannot render the card."""
+
+
+Part: TypeAlias = Union[TextPartResponse, MediaPartResponse, LinkPartResponse, PartIMessageAppPartResponse]
 
 
 class Message(BaseModel):

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/message_content_param.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from typing import Union, Iterable
-from typing_extensions import Required, TypeAlias, TypedDict
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
 from .reply_to_param import ReplyToParam
 from .link_part_param import LinkPartParam
@@ -12,9 +12,89 @@ from .media_part_param import MediaPartParam
 from .shared.service_type import ServiceType
 from .message_effect_param import MessageEffectParam
 
-__all__ = ["MessageContentParam", "Part"]
+__all__ = ["MessageContentParam", "Part", "PartIMessageAppPart", "PartIMessageAppPartApp", "PartIMessageAppPartLayout"]
 
-Part: TypeAlias = Union[TextPartParam, MediaPartParam, LinkPartParam]
+
+class PartIMessageAppPartApp(TypedDict, total=False):
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    bundle_id: Required[str]
+    """Bundle identifier of the Messages app extension. Must not contain `:`."""
+
+    name: Required[str]
+    """Display name of the app, shown by Messages' fallback UI."""
+
+    team_id: Required[str]
+    """The app's 10-character uppercase alphanumeric team identifier."""
+
+    app_store_id: int
+    """The owning app's App Store id (optional).
+
+    When set, recipients without the iMessage app installed see a "Get the app"
+    affordance.
+    """
+
+
+class PartIMessageAppPartLayout(TypedDict, total=False):
+    """Visible layout of the card.
+
+    At least one of
+    `caption`, `subcaption`, `trailing_caption`, or `trailing_subcaption` must be set, otherwise
+    the card renders as an empty bubble. Any image on the card is drawn by the recipient's
+    installed app extension; it cannot be supplied here.
+    """
+
+    caption: str
+    """Primary label, top-left and bold."""
+
+    subcaption: str
+    """Secondary label, below `caption` on the left."""
+
+    trailing_caption: str
+    """Label shown top-right."""
+
+    trailing_subcaption: str
+    """Label shown below `trailing_caption`, on the right."""
+
+
+class PartIMessageAppPart(TypedDict, total=False):
+    """An iMessage app card, backed by a Messages app extension.
+
+    iMessage only —
+    an `imessage_app` part must be the **only** part in the message and is never delivered over
+    SMS/RCS. See the IMessageAppServiceUnsupported (2018) and RecipientUnsupportedMessageType
+    (4005) error codes.
+    """
+
+    app: Required[PartIMessageAppPartApp]
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    layout: Required[PartIMessageAppPartLayout]
+    """Visible layout of the card.
+
+    At least one of `caption`, `subcaption`, `trailing_caption`, or
+    `trailing_subcaption` must be set, otherwise the card renders as an empty
+    bubble. Any image on the card is drawn by the recipient's installed app
+    extension; it cannot be supplied here.
+    """
+
+    type: Required[Literal["imessage_app"]]
+    """Indicates this is an iMessage app card part."""
+
+    url: Required[str]
+    """
+    Absolute HTTPS URL delivered to the recipient's installed iMessage app when they
+    tap the card. Opaque to Messages.
+    """
+
+    fallback_text: str
+    """Text shown on surfaces that cannot render the card (notifications, lock screen).
+
+    Defaults to the caption when omitted.
+    """
+
+
+Part: TypeAlias = Union[TextPartParam, MediaPartParam, LinkPartParam, PartIMessageAppPart]
 
 
 class MessageContentParam(TypedDict, total=False):

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/message_event_v2.py

@@ -12,7 +12,17 @@ from .schemas_message_effect import SchemasMessageEffect
 from .schemas_text_part_response import SchemasTextPartResponse
 from .schemas_media_part_response import SchemasMediaPartResponse
 
-__all__ = ["MessageEventV2", "Chat", "ChatHealthStatus", "Part", "PartSchemasLinkPartResponse", "ReplyTo"]
+__all__ = [
+    "MessageEventV2",
+    "Chat",
+    "ChatHealthStatus",
+    "Part",
+    "PartSchemasLinkPartResponse",
+    "PartSchemasIMessageAppPartResponse",
+    "PartSchemasIMessageAppPartResponseApp",
+    "PartSchemasIMessageAppPartResponseLayout",
+    "ReplyTo",
+]
 
 
 class ChatHealthStatus(BaseModel):
@@ -77,8 +87,64 @@ class PartSchemasLinkPartResponse(BaseModel):
     """The URL"""
 
 
+class PartSchemasIMessageAppPartResponseApp(BaseModel):
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    bundle_id: str
+    """Bundle identifier of the Messages app extension."""
+
+    name: str
+    """Display name of the app."""
+
+    team_id: str
+    """The app's 10-character team identifier."""
+
+    app_store_id: Optional[int] = None
+    """The owning app's App Store id, when known."""
+
+
+class PartSchemasIMessageAppPartResponseLayout(BaseModel):
+    """Visible layout of the card."""
+
+    caption: Optional[str] = None
+    """Primary label, top-left and bold."""
+
+    subcaption: Optional[str] = None
+    """Secondary label, below caption on the left."""
+
+    trailing_caption: Optional[str] = None
+    """Label shown top-right."""
+
+    trailing_subcaption: Optional[str] = None
+    """Label shown below trailing_caption."""
+
+
+class PartSchemasIMessageAppPartResponse(BaseModel):
+    """An iMessage app card part."""
+
+    app: PartSchemasIMessageAppPartResponseApp
+    """Identifies the iMessage app (Messages app extension) that backs the card."""
+
+    layout: PartSchemasIMessageAppPartResponseLayout
+    """Visible layout of the card."""
+
+    type: Literal["imessage_app"]
+    """Indicates this is an iMessage app card part."""
+
+    url: str
+    """The URL delivered to the iMessage app on tap."""
+
+    fallback_text: Optional[str] = None
+    """Fallback text for surfaces that cannot render the card."""
+
+
 Part: TypeAlias = Annotated[
-    Union[SchemasTextPartResponse, SchemasMediaPartResponse, PartSchemasLinkPartResponse],
+    Union[
+        SchemasTextPartResponse,
+        SchemasMediaPartResponse,
+        PartSchemasLinkPartResponse,
+        PartSchemasIMessageAppPartResponse,
+    ],
     PropertyInfo(discriminator="type"),
 ]
 

linq_python-0.15.0/src/linq/types/phone_number_list_response.py

@@ -0,0 +1,99 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["PhoneNumberListResponse", "PhoneNumber", "PhoneNumberHealthStatus", "PhoneNumberReputation"]
+
+
+class PhoneNumberHealthStatus(BaseModel):
+    """**[BETA]** Current reputation for a phone line.
+
+    Always present — lines start at `HEALTHY` and may shift based on aggregate engagement and delivery signals across all conversations on the line.
+
+    Unlike chat health, line reputation does not include `opted_out` — opt-out applies to individual recipients, not the whole line.
+
+    See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each status means and how to react.
+    """
+
+    doc_url: str
+    """Deep-link to the relevant section of the Phone Health guide for this status."""
+
+    status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]
+    """Current reputation of this phone line as assessed by risk-service.
+
+    - `HEALTHY` — No elevated risk detected.
+    - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
+      reviewing messaging patterns.
+    - `CRITICAL` — High risk; further sending may result in line flagging or
+      restriction.
+
+    Defaults to `HEALTHY` for lines that have not yet been scored.
+    """
+
+
+class PhoneNumberReputation(BaseModel):
+    """**[BETA]** Current reputation for a phone line.
+
+    Always present — lines start at `HEALTHY` and may shift based on aggregate engagement and delivery signals across all conversations on the line.
+
+    Unlike chat health, line reputation does not include `opted_out` — opt-out applies to individual recipients, not the whole line.
+
+    See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each status means and how to react.
+    """
+
+    doc_url: str
+    """Deep-link to the relevant section of the Phone Health guide for this status."""
+
+    status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]
+    """Current reputation of this phone line as assessed by risk-service.
+
+    - `HEALTHY` — No elevated risk detected.
+    - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
+      reviewing messaging patterns.
+    - `CRITICAL` — High risk; further sending may result in line flagging or
+      restriction.
+
+    Defaults to `HEALTHY` for lines that have not yet been scored.
+    """
+
+
+class PhoneNumber(BaseModel):
+    id: str
+    """Unique identifier for the phone number"""
+
+    health_status: PhoneNumberHealthStatus
+    """**[BETA]** Current reputation for a phone line.
+
+    Always present — lines start at `HEALTHY` and may shift based on aggregate
+    engagement and delivery signals across all conversations on the line.
+
+    Unlike chat health, line reputation does not include `opted_out` — opt-out
+    applies to individual recipients, not the whole line.
+
+    See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
+    status means and how to react.
+    """
+
+    phone_number: str
+    """Phone number in E.164 format"""
+
+    reputation: PhoneNumberReputation
+    """**[BETA]** Current reputation for a phone line.
+
+    Always present — lines start at `HEALTHY` and may shift based on aggregate
+    engagement and delivery signals across all conversations on the line.
+
+    Unlike chat health, line reputation does not include `opted_out` — opt-out
+    applies to individual recipients, not the whole line.
+
+    See the [Phone Health guide](/guides/phone-numbers/phone-health) for what each
+    status means and how to react.
+    """
+
+
+class PhoneNumberListResponse(BaseModel):
+    phone_numbers: List[PhoneNumber]
+    """List of phone numbers assigned to the partner"""

{linq_python-0.13.0 → linq_python-0.15.0}/src/linq/types/phone_number_status_updated_webhook_event.py

@@ -15,7 +15,19 @@ class Data(BaseModel):
     """When the status change occurred"""
 
     new_health_status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]
-    """The new line health status"""
+    """Current reputation of this phone line as assessed by risk-service.
+
+    - `HEALTHY` — No elevated risk detected.
+    - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
+      reviewing messaging patterns.
+    - `CRITICAL` — High risk; further sending may result in line flagging or
+      restriction.
+
+    Defaults to `HEALTHY` for lines that have not yet been scored.
+    """
+
+    new_reputation: Literal["HEALTHY", "AT_RISK", "CRITICAL"]
+    """The new line reputation"""
 
     new_status: Literal["ACTIVE", "FLAGGED"]
     """The new service status"""
@@ -24,7 +36,19 @@ class Data(BaseModel):
     """Phone number in E.164 format"""
 
     previous_health_status: Literal["HEALTHY", "AT_RISK", "CRITICAL"]
-    """The previous line health status"""
+    """Current reputation of this phone line as assessed by risk-service.
+
+    - `HEALTHY` — No elevated risk detected.
+    - `AT_RISK` — Elevated risk indicators present; consider reducing send volume or
+      reviewing messaging patterns.
+    - `CRITICAL` — High risk; further sending may result in line flagging or
+      restriction.
+
+    Defaults to `HEALTHY` for lines that have not yet been scored.
+    """
+
+    previous_reputation: Literal["HEALTHY", "AT_RISK", "CRITICAL"]
+    """The previous line reputation"""
 
     previous_status: Literal["ACTIVE", "FLAGGED"]
     """The previous service status"""