@remit/api-openapi-spec 0.0.20 → 0.0.22

package/openapi.json

@@ -1573,7 +1573,7 @@
             "name": "count",
             "in": "query",
             "required": false,
-            "description": "Include a count of matches within the server-capped window.",
+            "description": "Include how many messages the query matches. Counted over the whole mailbox, independent of `limit`.",
             "schema": {
               "type": "boolean"
             }
@@ -1591,7 +1591,7 @@
             "name": "limit",
             "in": "query",
             "required": false,
-            "description": "Caller-set recency window, capped server-side at 500. Bounds the read.",
+            "description": "Page size for the rows returned, capped server-side at 500. Bounds the read, not the `count`.",
             "schema": {
               "type": "integer",
               "format": "int32"
@@ -4170,6 +4170,16 @@
         },
         "description": "Complete message description including all related data. Body content is delivered via the per-part `BodyPartResponse.contentUrl` (CloudFront, JWT-authorized at the edge); the legacy `bodyText`/`bodyHtml` fields were removed once content delivery cut over end-to-end (#224)."
       },
+      "RemitImap.DisplayNameCorrespondence": {
+        "type": "string",
+        "enum": [
+          "Corresponds",
+          "Lookalike",
+          "Unrelated",
+          "NoClaim"
+        ],
+        "description": "How the From display name relates to the From domain. `Corresponds` — the name is contained in the domain. `Lookalike` — the name is one or two characters away from a domain label. `Unrelated` — no relation. `NoClaim` — the name is empty or is the address itself, so it claims no identity."
+      },
       "RemitImap.EmptyTrashResponse": {
         "type": "object",
         "required": [
@@ -4892,6 +4902,21 @@
           "dkimMismatch": {
             "type": "boolean",
             "description": "True when DKIM signing domain(s) are present and none aligns with the From domain"
+          },
+          "displayNameCorrespondence": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.DisplayNameCorrespondence"
+              }
+            ],
+            "description": "How the From display name relates to the From domain. Present only for a message the provider's own filter already classified as spam, and only when the sender is not bulk-shaped (no List-Unsubscribe) — absence means the comparison was never made, never that it found nothing."
+          },
+          "offDomainLinkDomains": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Registrable domains (eTLD+1) the body's links point at, excluding the From address's own registrable domain. Present only for a message the provider's own filter already classified as spam; an empty array means every link stayed on the sender's domain, absence means the comparison was never made."
           }
         },
         "description": "Structured sender-authenticity signal, derived from headers at classification time. Absent for messages classified before this field was introduced — clients should treat absence as no-signal."
@@ -6450,10 +6475,10 @@
           "count": {
             "type": "integer",
             "format": "int32",
-            "description": "Number of matches within the server-capped window. Present only when `count=true`."
+            "description": "How many messages the query matches, over the whole mailbox and independent of `limit`. Present only when `count=true`. With `senderTrust` or `dkimMismatch` in the query the count is over the enriched window instead, since those are resolved off the row."
           }
         },
-        "description": "Aggregate response for `searchThreads`. Carries the matching rows (`items`), a\npagination `continuationToken`, and an optional `count` of matches within the\nserver-capped window. `items` is omitted when `results=false` (count-only);\n`count` is present only when `count=true`. Thread-specific so the shared\n`ResultList<T>` (7 endpoints) stays untouched."
+        "description": "Aggregate response for `searchThreads`. Carries the matching rows (`items`), a\npagination `continuationToken`, and an optional `count` of every message the\nquery matches. `items` is omitted when `results=false` (count-only); `count` is\npresent only when `count=true`. Thread-specific so the shared `ResultList<T>`\n(7 endpoints) stays untouched."
       },
       "RemitImap.TrustedFlag": {
         "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",