primitivedotdev 1.36.0__tar.gz → 2.1.0__tar.gz

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: primitivedotdev
-Version: 1.36.0
+Version: 2.1.0
 Summary: Official Primitive Python SDK for webhook handling and API access
 Project-URL: Homepage, https://primitive.dev
 Project-URL: Repository, https://github.com/primitivedotdev/sdks
@@ -571,6 +571,44 @@ Function scope is available on the generated memory operations with
 `scope_type="function"` and `scope_id=<function-id>`; the id is the function
 UUID, not the function name.
 
+### Searching received mail
+
+`search_emails` calls `GET /emails/search`. Each result carries `thread_id`
+(`None` until the email has been threaded) and `direction`. Pass `thread_id`
+to search one conversation, `prefix=SearchEmailsPrefix.TRUE` to match the last
+word of `q` as a prefix while someone is still typing, and
+`count=SearchEmailsCount.FALSE` to skip the total count when you only need the
+page.
+
+```python
+from primitive.api import create_client
+from primitive.api.api.emails.search_emails import sync as search_emails
+from primitive.api.models.search_emails_count import SearchEmailsCount
+from primitive.api.models.search_emails_include_facets import (
+    SearchEmailsIncludeFacets,
+)
+from primitive.api.models.search_emails_prefix import SearchEmailsPrefix
+
+client = create_client("prim_test")
+page = search_emails(
+    client=client,
+    q="quarterly invoi",
+    prefix=SearchEmailsPrefix.TRUE,
+    count=SearchEmailsCount.FALSE,
+    include_facets=SearchEmailsIncludeFacets.FALSE,
+)
+```
+
+`page.meta.total` is `None` when the request sets `count` to false and an
+`int` otherwise; use `page.meta.cursor` to tell whether another page exists.
+Turning `include_facets` off skips the facet aggregation entirely. Search text
+containing a NUL character is rejected with a 400 validation error.
+
+Upgrading to 2.0: `EmailSearchMeta.total` is now typed `int | None`. It is
+`None` only when the request sets `count=SearchEmailsCount.FALSE`; type-checked
+code that treats it as an `int` needs a `None` check. Search results also gain
+the required `thread_id` and `direction` fields.
+
 ### Payment and interaction webhook events
 
 Webhooks are not email-only. The same endpoint also receives `payment.*` settlement notifications and `interaction.x402.*` events from the x402-over-email flow. The event name is carried in the **`X-Webhook-Event` header** for every family. The body is sent verbatim with no envelope, so it is the header (not a body field) that names the event: an `email.*` body carries `event`, a `payment.*` body carries the name in `type`, and an `interaction.*` body is just `{"interaction": {...}}` with no event/type field at all.
@@ -658,10 +696,16 @@ do not replace the idempotency key or retry as a fresh message to bypass it.
 
 ## Receive events in your process
 
+Event subscriptions require a connected agent credential (an API key starting
+with `pconn_`), and each one receives that agent's own address. An account API
+key is refused with `pull_subscription_requires_agent_connection` before any
+request is made; receive mail with `GET /emails?since=<cursor>&wait=30` or an
+HTTP webhook endpoint instead.
+
 ```python
 from primitive import PrimitiveClient, LocalEvent, EventContext
 
-client = PrimitiveClient(api_key="prim_...")
+client = PrimitiveClient(api_key="pconn_...")
 
 async def receive(event: LocalEvent, context: EventContext) -> None:
     await app.receive(event)  # Accept or enqueue within 30 seconds.

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/README.md

@@ -541,6 +541,44 @@ Function scope is available on the generated memory operations with
 `scope_type="function"` and `scope_id=<function-id>`; the id is the function
 UUID, not the function name.
 
+### Searching received mail
+
+`search_emails` calls `GET /emails/search`. Each result carries `thread_id`
+(`None` until the email has been threaded) and `direction`. Pass `thread_id`
+to search one conversation, `prefix=SearchEmailsPrefix.TRUE` to match the last
+word of `q` as a prefix while someone is still typing, and
+`count=SearchEmailsCount.FALSE` to skip the total count when you only need the
+page.
+
+```python
+from primitive.api import create_client
+from primitive.api.api.emails.search_emails import sync as search_emails
+from primitive.api.models.search_emails_count import SearchEmailsCount
+from primitive.api.models.search_emails_include_facets import (
+    SearchEmailsIncludeFacets,
+)
+from primitive.api.models.search_emails_prefix import SearchEmailsPrefix
+
+client = create_client("prim_test")
+page = search_emails(
+    client=client,
+    q="quarterly invoi",
+    prefix=SearchEmailsPrefix.TRUE,
+    count=SearchEmailsCount.FALSE,
+    include_facets=SearchEmailsIncludeFacets.FALSE,
+)
+```
+
+`page.meta.total` is `None` when the request sets `count` to false and an
+`int` otherwise; use `page.meta.cursor` to tell whether another page exists.
+Turning `include_facets` off skips the facet aggregation entirely. Search text
+containing a NUL character is rejected with a 400 validation error.
+
+Upgrading to 2.0: `EmailSearchMeta.total` is now typed `int | None`. It is
+`None` only when the request sets `count=SearchEmailsCount.FALSE`; type-checked
+code that treats it as an `int` needs a `None` check. Search results also gain
+the required `thread_id` and `direction` fields.
+
 ### Payment and interaction webhook events
 
 Webhooks are not email-only. The same endpoint also receives `payment.*` settlement notifications and `interaction.x402.*` events from the x402-over-email flow. The event name is carried in the **`X-Webhook-Event` header** for every family. The body is sent verbatim with no envelope, so it is the header (not a body field) that names the event: an `email.*` body carries `event`, a `payment.*` body carries the name in `type`, and an `interaction.*` body is just `{"interaction": {...}}` with no event/type field at all.
@@ -628,10 +666,16 @@ do not replace the idempotency key or retry as a fresh message to bypass it.
 
 ## Receive events in your process
 
+Event subscriptions require a connected agent credential (an API key starting
+with `pconn_`), and each one receives that agent's own address. An account API
+key is refused with `pull_subscription_requires_agent_connection` before any
+request is made; receive mail with `GET /emails?since=<cursor>&wait=30` or an
+HTTP webhook endpoint instead.
+
 ```python
 from primitive import PrimitiveClient, LocalEvent, EventContext
 
-client = PrimitiveClient(api_key="prim_...")
+client = PrimitiveClient(api_key="pconn_...")
 
 async def receive(event: LocalEvent, context: EventContext) -> None:
     await app.receive(event)  # Accept or enqueue within 30 seconds.

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/json-schema/email-received-event.schema.json

@@ -199,6 +199,10 @@
             "auth": {
               "$ref": "#/definitions/EmailAuth",
               "description": "Email authentication results (SPF, DKIM, DMARC)."
+            },
+            "relay": {
+              "anyOf": [{ "$ref": "#/definitions/EmailRelay" }, { "type": "null" }],
+              "description": "Set when the message reached Primitive through a Primitive mail relay. Null for other mail. The field may be absent; treat a missing value the same as null."
             }
           },
           "required": [
@@ -223,6 +227,21 @@
       ],
       "description": "Webhook payload for the `email.received` event.\n\nThis is delivered to your webhook endpoint when Primitive receives an email matching your domain configuration."
     },
+    "EmailRelay": {
+      "type": "object",
+      "properties": {
+        "hostname": {
+          "type": "string",
+          "description": "The relay hostname the domain's MX record points at."
+        },
+        "via": {
+          "type": "string",
+          "description": "How the message arrived. Currently always `mail_relay`. Treat an unfamiliar value as one added after your client was built."
+        }
+      },
+      "required": ["hostname", "via"],
+      "description": "How an inbound message reached Primitive when it arrived through a Primitive mail relay."
+    },
     "RoutingDecision": {
       "type": "object",
       "description": "The recipient-routing decision for an inbound email: which endpoint it resolved to and why. Present on the event only when recipient routing ran for the organization.",

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "primitivedotdev"
-version = "1.36.0"
+version = "2.1.0"
 description = "Official Primitive Python SDK for webhook handling and API access"
 readme = "README.md"
 requires-python = ">=3.11"

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/src/primitive/__init__.py

@@ -76,6 +76,7 @@ from .types import (
     EmailAnalysis,
     EmailAuth,
     EmailReceivedEvent,
+    EmailRelay,
     EventType,
     ForwardAnalysis,
     ForwardOriginalSender,
@@ -198,6 +199,7 @@ __all__ = [
     "EmailAnalysis",
     "EmailAuth",
     "EmailReceivedEvent",
+    "EmailRelay",
     "EventType",
     "ForwardAnalysis",
     "ForwardOriginalSender",

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/src/primitive/api/api/emails/search_emails.py

@@ -12,8 +12,10 @@ from ...models.email_status import EmailStatus
 from ...models.error_response import ErrorResponse
 from ...models.search_emails_automated import SearchEmailsAutomated
 from ...models.search_emails_awaiting import SearchEmailsAwaiting
+from ...models.search_emails_count import SearchEmailsCount
 from ...models.search_emails_has_attachment import SearchEmailsHasAttachment
 from ...models.search_emails_include_facets import SearchEmailsIncludeFacets
+from ...models.search_emails_prefix import SearchEmailsPrefix
 from ...models.search_emails_response_200 import SearchEmailsResponse200
 from ...models.search_emails_snippet import SearchEmailsSnippet
 from ...models.search_emails_sort import SearchEmailsSort
@@ -46,6 +48,9 @@ def _get_kwargs(
     limit: int | Unset = 50,
     snippet: SearchEmailsSnippet | Unset = SearchEmailsSnippet.TRUE,
     include_facets: SearchEmailsIncludeFacets | Unset = SearchEmailsIncludeFacets.TRUE,
+    thread_id: UUID | Unset = UNSET,
+    prefix: SearchEmailsPrefix | Unset = SearchEmailsPrefix.FALSE,
+    count: SearchEmailsCount | Unset = SearchEmailsCount.TRUE,
 
 ) -> dict[str, Any]:
     
@@ -134,6 +139,23 @@ def _get_kwargs(
 
     params["include_facets"] = json_include_facets
 
+    json_thread_id: str | Unset = UNSET
+    if not isinstance(thread_id, Unset):
+        json_thread_id = str(thread_id)
+    params["thread_id"] = json_thread_id
+
+    json_prefix: str | Unset = UNSET
+    if not isinstance(prefix, Unset):
+        json_prefix = prefix.value
+
+    params["prefix"] = json_prefix
+
+    json_count: str | Unset = UNSET
+    if not isinstance(count, Unset):
+        json_count = count.value
+
+    params["count"] = json_count
+
 
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
@@ -223,6 +245,9 @@ def sync_detailed(
     limit: int | Unset = 50,
     snippet: SearchEmailsSnippet | Unset = SearchEmailsSnippet.TRUE,
     include_facets: SearchEmailsIncludeFacets | Unset = SearchEmailsIncludeFacets.TRUE,
+    thread_id: UUID | Unset = UNSET,
+    prefix: SearchEmailsPrefix | Unset = SearchEmailsPrefix.FALSE,
+    count: SearchEmailsCount | Unset = SearchEmailsCount.TRUE,
 
 ) -> Response[ErrorResponse | SearchEmailsResponse200]:
     """ Search inbound emails
@@ -239,6 +264,10 @@ def sync_detailed(
     `domain_id`, status, attachment presence, and spam score bounds
     are combined with the text query.
 
+    The text parameters (`q`, `from`, `to`, `subject` and `body`) must not
+    contain a NUL character; a value that does is rejected with a 400
+    validation error.
+
     Connected-agent credentials search only mail received by their own
     address. This applies to results, totals, facets, and every page;
     search filters cannot widen the credential's scope. When
@@ -295,6 +324,9 @@ def sync_detailed(
         snippet (SearchEmailsSnippet | Unset):  Default: SearchEmailsSnippet.TRUE.
         include_facets (SearchEmailsIncludeFacets | Unset):  Default:
             SearchEmailsIncludeFacets.TRUE.
+        thread_id (UUID | Unset):
+        prefix (SearchEmailsPrefix | Unset):  Default: SearchEmailsPrefix.FALSE.
+        count (SearchEmailsCount | Unset):  Default: SearchEmailsCount.TRUE.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -326,6 +358,9 @@ cursor=cursor,
 limit=limit,
 snippet=snippet,
 include_facets=include_facets,
+thread_id=thread_id,
+prefix=prefix,
+count=count,
 
     )
 
@@ -358,6 +393,9 @@ def sync(
     limit: int | Unset = 50,
     snippet: SearchEmailsSnippet | Unset = SearchEmailsSnippet.TRUE,
     include_facets: SearchEmailsIncludeFacets | Unset = SearchEmailsIncludeFacets.TRUE,
+    thread_id: UUID | Unset = UNSET,
+    prefix: SearchEmailsPrefix | Unset = SearchEmailsPrefix.FALSE,
+    count: SearchEmailsCount | Unset = SearchEmailsCount.TRUE,
 
 ) -> ErrorResponse | SearchEmailsResponse200 | None:
     """ Search inbound emails
@@ -374,6 +412,10 @@ def sync(
     `domain_id`, status, attachment presence, and spam score bounds
     are combined with the text query.
 
+    The text parameters (`q`, `from`, `to`, `subject` and `body`) must not
+    contain a NUL character; a value that does is rejected with a 400
+    validation error.
+
     Connected-agent credentials search only mail received by their own
     address. This applies to results, totals, facets, and every page;
     search filters cannot widen the credential's scope. When
@@ -430,6 +472,9 @@ def sync(
         snippet (SearchEmailsSnippet | Unset):  Default: SearchEmailsSnippet.TRUE.
         include_facets (SearchEmailsIncludeFacets | Unset):  Default:
             SearchEmailsIncludeFacets.TRUE.
+        thread_id (UUID | Unset):
+        prefix (SearchEmailsPrefix | Unset):  Default: SearchEmailsPrefix.FALSE.
+        count (SearchEmailsCount | Unset):  Default: SearchEmailsCount.TRUE.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -462,6 +507,9 @@ cursor=cursor,
 limit=limit,
 snippet=snippet,
 include_facets=include_facets,
+thread_id=thread_id,
+prefix=prefix,
+count=count,
 
     ).parsed
 
@@ -488,6 +536,9 @@ async def asyncio_detailed(
     limit: int | Unset = 50,
     snippet: SearchEmailsSnippet | Unset = SearchEmailsSnippet.TRUE,
     include_facets: SearchEmailsIncludeFacets | Unset = SearchEmailsIncludeFacets.TRUE,
+    thread_id: UUID | Unset = UNSET,
+    prefix: SearchEmailsPrefix | Unset = SearchEmailsPrefix.FALSE,
+    count: SearchEmailsCount | Unset = SearchEmailsCount.TRUE,
 
 ) -> Response[ErrorResponse | SearchEmailsResponse200]:
     """ Search inbound emails
@@ -504,6 +555,10 @@ async def asyncio_detailed(
     `domain_id`, status, attachment presence, and spam score bounds
     are combined with the text query.
 
+    The text parameters (`q`, `from`, `to`, `subject` and `body`) must not
+    contain a NUL character; a value that does is rejected with a 400
+    validation error.
+
     Connected-agent credentials search only mail received by their own
     address. This applies to results, totals, facets, and every page;
     search filters cannot widen the credential's scope. When
@@ -560,6 +615,9 @@ async def asyncio_detailed(
         snippet (SearchEmailsSnippet | Unset):  Default: SearchEmailsSnippet.TRUE.
         include_facets (SearchEmailsIncludeFacets | Unset):  Default:
             SearchEmailsIncludeFacets.TRUE.
+        thread_id (UUID | Unset):
+        prefix (SearchEmailsPrefix | Unset):  Default: SearchEmailsPrefix.FALSE.
+        count (SearchEmailsCount | Unset):  Default: SearchEmailsCount.TRUE.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -591,6 +649,9 @@ cursor=cursor,
 limit=limit,
 snippet=snippet,
 include_facets=include_facets,
+thread_id=thread_id,
+prefix=prefix,
+count=count,
 
     )
 
@@ -623,6 +684,9 @@ async def asyncio(
     limit: int | Unset = 50,
     snippet: SearchEmailsSnippet | Unset = SearchEmailsSnippet.TRUE,
     include_facets: SearchEmailsIncludeFacets | Unset = SearchEmailsIncludeFacets.TRUE,
+    thread_id: UUID | Unset = UNSET,
+    prefix: SearchEmailsPrefix | Unset = SearchEmailsPrefix.FALSE,
+    count: SearchEmailsCount | Unset = SearchEmailsCount.TRUE,
 
 ) -> ErrorResponse | SearchEmailsResponse200 | None:
     """ Search inbound emails
@@ -639,6 +703,10 @@ async def asyncio(
     `domain_id`, status, attachment presence, and spam score bounds
     are combined with the text query.
 
+    The text parameters (`q`, `from`, `to`, `subject` and `body`) must not
+    contain a NUL character; a value that does is rejected with a 400
+    validation error.
+
     Connected-agent credentials search only mail received by their own
     address. This applies to results, totals, facets, and every page;
     search filters cannot widen the credential's scope. When
@@ -695,6 +763,9 @@ async def asyncio(
         snippet (SearchEmailsSnippet | Unset):  Default: SearchEmailsSnippet.TRUE.
         include_facets (SearchEmailsIncludeFacets | Unset):  Default:
             SearchEmailsIncludeFacets.TRUE.
+        thread_id (UUID | Unset):
+        prefix (SearchEmailsPrefix | Unset):  Default: SearchEmailsPrefix.FALSE.
+        count (SearchEmailsCount | Unset):  Default: SearchEmailsCount.TRUE.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -727,5 +798,8 @@ cursor=cursor,
 limit=limit,
 snippet=snippet,
 include_facets=include_facets,
+thread_id=thread_id,
+prefix=prefix,
+count=count,
 
     )).parsed

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/src/primitive/api/models/__init__.py

@@ -201,6 +201,7 @@ from .email_auth import EmailAuth
 from .email_detail import EmailDetail
 from .email_detail_automation_headers_type_0 import EmailDetailAutomationHeadersType0
 from .email_detail_awaiting import EmailDetailAwaiting
+from .email_detail_relay_type_0 import EmailDetailRelayType0
 from .email_detail_repeat_type_0 import EmailDetailRepeatType0
 from .email_detail_reply import EmailDetailReply
 from .email_detail_sender_member_type_0 import EmailDetailSenderMemberType0
@@ -211,10 +212,12 @@ from .email_search_highlights import EmailSearchHighlights
 from .email_search_meta import EmailSearchMeta
 from .email_search_meta_sort import EmailSearchMetaSort
 from .email_search_result import EmailSearchResult
+from .email_search_result_direction import EmailSearchResultDirection
 from .email_status import EmailStatus
 from .email_summary import EmailSummary
 from .email_summary_automation_headers_type_0 import EmailSummaryAutomationHeadersType0
 from .email_summary_awaiting import EmailSummaryAwaiting
+from .email_summary_relay_type_0 import EmailSummaryRelayType0
 from .email_summary_repeat_type_0 import EmailSummaryRepeatType0
 from .email_summary_sender_member_type_0 import EmailSummarySenderMemberType0
 from .email_webhook_status_type_1 import EmailWebhookStatusType1
@@ -472,8 +475,10 @@ from .run_wake_schedule_response_200 import RunWakeScheduleResponse200
 from .run_wake_schedule_response_200_data import RunWakeScheduleResponse200Data
 from .search_emails_automated import SearchEmailsAutomated
 from .search_emails_awaiting import SearchEmailsAwaiting
+from .search_emails_count import SearchEmailsCount
 from .search_emails_has_attachment import SearchEmailsHasAttachment
 from .search_emails_include_facets import SearchEmailsIncludeFacets
+from .search_emails_prefix import SearchEmailsPrefix
 from .search_emails_response_200 import SearchEmailsResponse200
 from .search_emails_snippet import SearchEmailsSnippet
 from .search_emails_sort import SearchEmailsSort
@@ -855,6 +860,7 @@ __all__ = (
     "EmailDetail",
     "EmailDetailAutomationHeadersType0",
     "EmailDetailAwaiting",
+    "EmailDetailRelayType0",
     "EmailDetailRepeatType0",
     "EmailDetailReply",
     "EmailDetailSenderMemberType0",
@@ -865,10 +871,12 @@ __all__ = (
     "EmailSearchMeta",
     "EmailSearchMetaSort",
     "EmailSearchResult",
+    "EmailSearchResultDirection",
     "EmailStatus",
     "EmailSummary",
     "EmailSummaryAutomationHeadersType0",
     "EmailSummaryAwaiting",
+    "EmailSummaryRelayType0",
     "EmailSummaryRepeatType0",
     "EmailSummarySenderMemberType0",
     "EmailWebhookStatusType1",
@@ -1126,8 +1134,10 @@ __all__ = (
     "RunWakeScheduleResponse200Data",
     "SearchEmailsAutomated",
     "SearchEmailsAwaiting",
+    "SearchEmailsCount",
     "SearchEmailsHasAttachment",
     "SearchEmailsIncludeFacets",
+    "SearchEmailsPrefix",
     "SearchEmailsResponse200",
     "SearchEmailsSnippet",
     "SearchEmailsSort",

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/src/primitive/api/models/email_detail.py

@@ -20,6 +20,7 @@ import datetime
 if TYPE_CHECKING:
   from ..models.email_auth import EmailAuth
   from ..models.email_detail_automation_headers_type_0 import EmailDetailAutomationHeadersType0
+  from ..models.email_detail_relay_type_0 import EmailDetailRelayType0
   from ..models.email_detail_repeat_type_0 import EmailDetailRepeatType0
   from ..models.email_detail_reply import EmailDetailReply
   from ..models.email_detail_sender_member_type_0 import EmailDetailSenderMemberType0
@@ -278,6 +279,8 @@ class EmailDetail:
                 placeholder instead of the raw text. It is never evidence of an interaction: anyone can set that header or name
                 a part that way, so it must not grant trust or select an interaction kind. Ignore it once `interaction_hint` is
                 anything other than `pending`.
+            relay (EmailDetailRelayType0 | None | Unset): Set when the message reached Primitive through a Primitive mail
+                relay. Null for other mail. The field may be absent; treat a missing value the same as null.
      """
 
     id: UUID
@@ -331,6 +334,7 @@ class EmailDetail:
     interaction_hint: str | Unset = UNSET
     interaction_kind: None | str | Unset = UNSET
     interaction_candidate: bool | Unset = UNSET
+    relay: EmailDetailRelayType0 | None | Unset = UNSET
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
 
@@ -340,6 +344,7 @@ class EmailDetail:
     def to_dict(self) -> dict[str, Any]:
         from ..models.email_auth import EmailAuth # noqa: PLC0415
         from ..models.email_detail_automation_headers_type_0 import EmailDetailAutomationHeadersType0 # noqa: PLC0415
+        from ..models.email_detail_relay_type_0 import EmailDetailRelayType0 # noqa: PLC0415
         from ..models.email_detail_repeat_type_0 import EmailDetailRepeatType0 # noqa: PLC0415
         from ..models.email_detail_reply import EmailDetailReply # noqa: PLC0415
         from ..models.email_detail_sender_member_type_0 import EmailDetailSenderMemberType0 # noqa: PLC0415
@@ -602,6 +607,14 @@ class EmailDetail:
 
         interaction_candidate = self.interaction_candidate
 
+        relay: dict[str, Any] | None | Unset
+        if isinstance(self.relay, Unset):
+            relay = UNSET
+        elif isinstance(self.relay, EmailDetailRelayType0):
+            relay = self.relay.to_dict()
+        else:
+            relay = self.relay
+
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
@@ -690,6 +703,8 @@ class EmailDetail:
             field_dict["interaction_kind"] = interaction_kind
         if interaction_candidate is not UNSET:
             field_dict["interaction_candidate"] = interaction_candidate
+        if relay is not UNSET:
+            field_dict["relay"] = relay
 
         return field_dict
 
@@ -699,6 +714,7 @@ class EmailDetail:
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         from ..models.email_auth import EmailAuth # noqa: PLC0415
         from ..models.email_detail_automation_headers_type_0 import EmailDetailAutomationHeadersType0 # noqa: PLC0415
+        from ..models.email_detail_relay_type_0 import EmailDetailRelayType0 # noqa: PLC0415
         from ..models.email_detail_repeat_type_0 import EmailDetailRepeatType0 # noqa: PLC0415
         from ..models.email_detail_reply import EmailDetailReply # noqa: PLC0415
         from ..models.email_detail_sender_member_type_0 import EmailDetailSenderMemberType0 # noqa: PLC0415
@@ -1225,6 +1241,26 @@ class EmailDetail:
 
         interaction_candidate = d.pop("interaction_candidate", UNSET)
 
+        def _parse_relay(data: object) -> EmailDetailRelayType0 | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                relay_type_0 = EmailDetailRelayType0.from_dict(data)
+
+
+
+                return relay_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(EmailDetailRelayType0 | None | Unset, data)
+
+        relay = _parse_relay(d.pop("relay", UNSET))
+
+
         email_detail = cls(
             id=id,
             sender=sender,
@@ -1277,6 +1313,7 @@ class EmailDetail:
             interaction_hint=interaction_hint,
             interaction_kind=interaction_kind,
             interaction_candidate=interaction_candidate,
+            relay=relay,
         )
 
 

primitivedotdev-2.1.0/src/primitive/api/models/email_detail_relay_type_0.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+
+
+
+
+
+
+T = TypeVar("T", bound="EmailDetailRelayType0")
+
+
+
+@_attrs_define
+class EmailDetailRelayType0:
+    """ Set when the message reached Primitive through a Primitive mail relay. Null for other mail. The field may be absent;
+    treat a missing value the same as null.
+
+        Attributes:
+            hostname (str): The relay hostname the domain's MX record points at.
+            via (str): How the message arrived. Currently always `mail_relay`. Treat an unfamiliar value as one added after
+                your client was built.
+     """
+
+    hostname: str
+    via: str
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+
+
+
+
+    def to_dict(self) -> dict[str, Any]:
+        hostname = self.hostname
+
+        via = self.via
+
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({
+            "hostname": hostname,
+            "via": via,
+        })
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        hostname = d.pop("hostname")
+
+        via = d.pop("via")
+
+        email_detail_relay_type_0 = cls(
+            hostname=hostname,
+            via=via,
+        )
+
+
+        email_detail_relay_type_0.additional_properties = d
+        return email_detail_relay_type_0
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

{primitivedotdev-1.36.0 → primitivedotdev-2.1.0}/src/primitive/api/models/email_search_meta.py

@@ -24,14 +24,15 @@ T = TypeVar("T", bound="EmailSearchMeta")
 class EmailSearchMeta:
     """ 
         Attributes:
-            total (int): Total number of matching records, capped when `total_capped` is true.
+            total (int | None): Total number of matching records, capped when `total_capped` is true. Null when the request
+                set `count=false`.
             total_capped (bool): Whether `total` was capped instead of counted exactly.
             limit (int): Page size used for this request.
             cursor (None | str): Cursor for the next search page, or null if no more results.
             sort (EmailSearchMetaSort): Sort mode used for the result page.
      """
 
-    total: int
+    total: int | None
     total_capped: bool
     limit: int
     cursor: None | str
@@ -43,6 +44,7 @@ class EmailSearchMeta:
 
 
     def to_dict(self) -> dict[str, Any]:
+        total: int | None
         total = self.total
 
         total_capped = self.total_capped
@@ -72,7 +74,13 @@ class EmailSearchMeta:
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         d = dict(src_dict)
-        total = d.pop("total")
+        def _parse_total(data: object) -> int | None:
+            if data is None:
+                return data
+            return cast(int | None, data)
+
+        total = _parse_total(d.pop("total"))
+
 
         total_capped = d.pop("total_capped")