primitivedotdev 2.5.0__tar.gz → 2.6.0__tar.gz

{primitivedotdev-2.5.0 → primitivedotdev-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: primitivedotdev
-Version: 2.5.0
+Version: 2.6.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

{primitivedotdev-2.5.0 → primitivedotdev-2.6.0}/json-schema/email-received-event.schema.json

@@ -203,6 +203,15 @@
             "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."
+            },
+            "automated": {
+              "type": "boolean",
+              "description": "Whether the message was sent by a machine rather than a person (bounce, auto-reply, list or bulk mail, report, or mail from the address it was delivered to). Same value GET /v1/emails/{id} returns. The field may be absent; treat a missing value as unknown."
+            },
+            "automated_reasons": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Why automated is true, in rule order; empty when it is false. Current values: null_envelope_sender, no_identifiable_sender, own_address, mailer_daemon, auto_submitted, precedence, list_unsubscribe, list_id, auto_response_suppress, failed_recipients, report. Treat an unfamiliar value as one added after your client was built."
             }
           },
           "required": [

{primitivedotdev-2.5.0 → primitivedotdev-2.6.0}/pyproject.toml

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

{primitivedotdev-2.5.0 → primitivedotdev-2.6.0}/src/primitive/models_generated.py

@@ -1198,6 +1198,18 @@ class Email(BaseModel):
             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."
         ),
     ] = None
+    automated: Annotated[
+        bool | None,
+        Field(
+            description="Whether the message was sent by a machine rather than a person (bounce, auto-reply, list or bulk mail, report, or mail from the address it was delivered to). Same value GET /v1/emails/{id} returns. The field may be absent; treat a missing value as unknown."
+        ),
+    ] = None
+    automated_reasons: Annotated[
+        list[str] | None,
+        Field(
+            description="Why automated is true, in rule order; empty when it is false. Current values: null_envelope_sender, no_identifiable_sender, own_address, mailer_daemon, auto_submitted, precedence, list_unsubscribe, list_id, auto_response_suppress, failed_recipients, report. Treat an unfamiliar value as one added after your client was built."
+        ),
+    ] = None
 
 
 class EmailReceivedEvent(BaseModel):

{primitivedotdev-2.5.0 → primitivedotdev-2.6.0}/src/primitive/schemas/email_received_event.schema.json

@@ -203,6 +203,15 @@
             "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."
+            },
+            "automated": {
+              "type": "boolean",
+              "description": "Whether the message was sent by a machine rather than a person (bounce, auto-reply, list or bulk mail, report, or mail from the address it was delivered to). Same value GET /v1/emails/{id} returns. The field may be absent; treat a missing value as unknown."
+            },
+            "automated_reasons": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Why automated is true, in rule order; empty when it is false. Current values: null_envelope_sender, no_identifiable_sender, own_address, mailer_daemon, auto_submitted, precedence, list_unsubscribe, list_id, auto_response_suppress, failed_recipients, report. Treat an unfamiliar value as one added after your client was built."
             }
           },
           "required": [

{primitivedotdev-2.5.0 → primitivedotdev-2.6.0}/test-fixtures/webhook/validation-cases.json

@@ -703,6 +703,599 @@
         "error_code": "SCHEMA_VALIDATION_FAILED"
       }
     },
+    {
+      "name": "valid_payload_with_automated_true",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          },
+          "automated": true,
+          "automated_reasons": ["auto_submitted", "precedence"]
+        }
+      },
+      "expected": {
+        "valid": true,
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "automated": true,
+        "automated_reasons": ["auto_submitted", "precedence"]
+      }
+    },
+    {
+      "name": "valid_payload_with_automated_false",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          },
+          "automated": false,
+          "automated_reasons": []
+        }
+      },
+      "expected": {
+        "valid": true,
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "automated": false,
+        "automated_reasons": []
+      }
+    },
+    {
+      "name": "valid_payload_with_unfamiliar_automated_reason",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          },
+          "automated": true,
+          "automated_reasons": ["some_future_rule"]
+        }
+      },
+      "expected": {
+        "valid": true,
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "automated": true,
+        "automated_reasons": ["some_future_rule"]
+      }
+    },
+    {
+      "name": "valid_payload_without_automated",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          }
+        }
+      },
+      "expected": {
+        "valid": true,
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "automated": null,
+        "automated_reasons": null
+      }
+    },
+    {
+      "name": "invalid_automated_not_boolean",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          },
+          "automated": "yes"
+        }
+      },
+      "expected": {
+        "valid": false,
+        "error_code": "SCHEMA_VALIDATION_FAILED"
+      }
+    },
+    {
+      "name": "invalid_automated_reasons_not_array",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          },
+          "automated": true,
+          "automated_reasons": "auto_submitted"
+        }
+      },
+      "expected": {
+        "valid": false,
+        "error_code": "SCHEMA_VALIDATION_FAILED"
+      }
+    },
+    {
+      "name": "invalid_automated_reasons_non_string_item",
+      "payload": {
+        "id": "evt_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
+        "event": "email.received",
+        "version": "2025-12-14",
+        "delivery": {
+          "endpoint_id": "ep_xyz789",
+          "attempt": 1,
+          "attempted_at": "2025-12-14T12:00:00Z"
+        },
+        "email": {
+          "id": "em_def456",
+          "received_at": "2025-12-14T11:59:50Z",
+          "smtp": {
+            "helo": "mail.example.com",
+            "mail_from": "sender@example.com",
+            "rcpt_to": ["recipient@domain.com"]
+          },
+          "headers": {
+            "message_id": "<abc123@example.com>",
+            "subject": "Test Email",
+            "from": "sender@example.com",
+            "to": "recipient@domain.com",
+            "date": "Sat, 14 Dec 2025 11:59:50 +0000"
+          },
+          "content": {
+            "raw": {
+              "included": true,
+              "encoding": "base64",
+              "max_inline_bytes": 262144,
+              "size_bytes": 11,
+              "sha256": "a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e",
+              "data": "SGVsbG8gV29ybGQ="
+            },
+            "download": {
+              "url": "https://api.primitive.dev/v1/downloads/raw/token123",
+              "expires_at": "2025-12-15T12:00:00Z"
+            }
+          },
+          "parsed": {
+            "status": "complete",
+            "error": null,
+            "body_text": "Hello World",
+            "body_html": "<p>Hello World</p>",
+            "reply_to": null,
+            "cc": null,
+            "bcc": null,
+            "to_addresses": null,
+            "in_reply_to": null,
+            "references": null,
+            "attachments": [],
+            "attachments_download_url": null
+          },
+          "analysis": {},
+          "auth": {
+            "spf": "pass",
+            "dmarc": "pass",
+            "dmarcPolicy": "reject",
+            "dmarcFromDomain": "example.com",
+            "dmarcSpfAligned": true,
+            "dmarcDkimAligned": true,
+            "dmarcSpfStrict": false,
+            "dmarcDkimStrict": false,
+            "dkimSignatures": [
+              {
+                "domain": "example.com",
+                "selector": "default",
+                "result": "pass",
+                "aligned": true,
+                "keyBits": 2048,
+                "algo": "rsa-sha256"
+              }
+            ]
+          },
+          "automated": true,
+          "automated_reasons": [1]
+        }
+      },
+      "expected": {
+        "valid": false,
+        "error_code": "SCHEMA_VALIDATION_FAILED"
+      }
+    },
     {
       "name": "valid_bounce_linked_to_send",
       "payload": {