@remit/api-openapi-spec 0.0.43 → 0.0.45

package/openapi.json

@@ -2812,7 +2812,7 @@
             "name": "senderTrust",
             "in": "query",
             "required": false,
-            "description": "Filter to messages whose From address has one of these trust levels. Off-row criterion, resolved by in-handler enrichment over the capped window.",
+            "description": "Filter to messages whose From address has one of these trust levels. Off-row criterion: resolved by enriching the rows this page read, not by a predicate over the mailbox, so `count` comes back absent whenever it is supplied.",
             "schema": {
               "type": "array",
               "items": {
@@ -2836,7 +2836,7 @@
             "name": "dkimMismatch",
             "in": "query",
             "required": false,
-            "description": "Filter on the DKIM-alignment signal (true = DKIM mismatch). Off-row criterion; rows without an authenticity signal never match.",
+            "description": "Filter on the DKIM-alignment signal (true = DKIM mismatch). Off-row criterion, like `senderTrust`: rows without an authenticity signal never match, and `count` comes back absent whenever it is supplied.",
             "schema": {
               "type": "boolean"
             }
@@ -2845,7 +2845,7 @@
             "name": "count",
             "in": "query",
             "required": false,
-            "description": "Include how many messages the query matches. Counted over the whole mailbox, independent of `limit`.",
+            "description": "Include how many messages the query matches, exactly, over the whole mailbox. Opt-in because it is a second read over the entire match set rather than a by-product of the page: ask for it on a deliberate act, never on a keystroke. Answered as absent — not as a page length — when the query carries `senderTrust` or `dkimMismatch`, which no predicate can count.",
             "schema": {
               "type": "boolean"
             }
@@ -2863,7 +2863,7 @@
             "name": "limit",
             "in": "query",
             "required": false,
-            "description": "Page size for the rows returned, capped server-side at 500. Bounds the read, not the `count`.",
+            "description": "Page size for the rows returned, capped server-side at 500. It bounds this page and nothing else: `count` is over the whole mailbox and does not move when this does.",
             "schema": {
               "type": "integer",
               "format": "int32"
@@ -4170,7 +4170,7 @@
             "name": "count",
             "in": "query",
             "required": false,
-            "description": "Include how many messages the listing matches. Counted over the whole scope, independent of `limit`.",
+            "description": "Include how many conversations the listing matches, exactly, over the whole scope. Opt-in because it is a second read over the entire match set rather than a by-product of the page: ask for it on a deliberate act, never on a keystroke.",
             "schema": {
               "type": "boolean"
             }
@@ -7871,6 +7871,16 @@
         },
         "description": "Recorded when the user reported this message as spam via `POST /messages/report-spam`. Present means the report stands; absent means never reported, or reported and then undone via `POST /messages/not-spam` (which clears it). Backs the \"Reported as spam · Undo\" affordance independent of the message's current folder — the underlying move can settle, fail, or no-op (already in Junk) without changing whether the report itself is shown."
       },
+      "RemitImap.MessageStatus": {
+        "type": "string",
+        "enum": [
+          "active",
+          "deleting",
+          "deleted",
+          "moving"
+        ],
+        "description": "Message lifecycle status for move/delete operations"
+      },
       "RemitImap.MessageSummaryResponse": {
         "type": "object",
         "required": [
@@ -7878,7 +7888,9 @@
           "mailboxId",
           "uid",
           "rfc822Size",
-          "internalDate"
+          "internalDate",
+          "status",
+          "syncStatus"
         ],
         "properties": {
           "messageId": {
@@ -7924,6 +7936,26 @@
             "description": "Message-ID header value for quick reference",
             "readOnly": true
           },
+          "status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.MessageStatus"
+              }
+            ],
+            "description": "Message lifecycle status for move/delete operations. Defaults to `active` (normal, visible).",
+            "default": "active",
+            "readOnly": true
+          },
+          "syncStatus": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.MessageSyncStatus"
+              }
+            ],
+            "description": "Sync status for move/delete operations. The `synced` column default only applies to a row written without the field: the repository always supplies one, and an ordinary inbound sync writes `pending`, which nothing later promotes. So `pending` here does not mean an outstanding move or delete — `status` names that, and `failed` marks a mutation that gave up.",
+            "default": "synced",
+            "readOnly": true
+          },
           "authenticity": {
             "allOf": [
               {
@@ -7959,6 +7991,15 @@
         },
         "description": "Core message metadata for API responses"
       },
+      "RemitImap.MessageSyncStatus": {
+        "type": "string",
+        "enum": [
+          "synced",
+          "pending",
+          "failed"
+        ],
+        "description": "Sync status for message move/delete operations"
+      },
       "RemitImap.MintOutboxAttachmentInput": {
         "type": "object",
         "required": [
@@ -9494,7 +9535,9 @@
           "updatedAt",
           "category",
           "senderTrust",
-          "muted"
+          "muted",
+          "status",
+          "syncStatus"
         ],
         "properties": {
           "threadMessageId": {
@@ -9640,6 +9683,22 @@
             ],
             "description": "Structured sender-authenticity signal derived from DKIM headers at classification time (from the underlying Message). Absent for messages classified before this field was introduced — absence means no signal."
           },
+          "status": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.MessageStatus"
+              }
+            ],
+            "description": "Mutation lifecycle of the underlying Message, projected at read time — the ThreadMessage row has no column of its own. `active` means no move or delete is outstanding; `moving` or `deleting` means one is, and this row's folder is a local write the mail server has not confirmed."
+          },
+          "syncStatus": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.MessageSyncStatus"
+              }
+            ],
+            "description": "Sync status of the underlying Message, projected at read time. Read it WITH `status`, never alone: `message-move`, `message-delete` and `message-copy` all write `failed` on an ordinary transient attempt before a redelivery that usually succeeds, so `failed` by itself does not mean a mutation gave up. One pair does prove one: `active` + `failed`, written only by `abandonDelete` — a delete Remit refused to run and handed back. Nothing else here is decidable. A move that gave up leaves `moving` + `failed`, the same pair its first dropped connection leaves; a delete that exhausted its retries is repaired to `active` + `synced` and reads as settled; `flag-push` and `placement-move-push` never write either field."
+          },
           "accountId": {
             "allOf": [
               {
@@ -9695,7 +9754,7 @@
           "count": {
             "type": "integer",
             "format": "int32",
-            "description": "How much the query matches, over the whole scope and independent of `limit`.\nPresent only when `count=true`.\n\nEach operation counts what it lists. `searchThreads` lists messages of one\nmailbox and counts messages; with `senderTrust` or `dkimMismatch` in the\nquery that count is over the enriched window instead, since those are\nresolved off the row. `listAllThreads` counts CONVERSATIONS across every\nnon-muted mailbox of every account — a thread holding two matching messages\ncounts once, and so does one message reachable through a real folder and a\nvirtual copy of it — because that is what the cross-account listing renders\nafter collapsing by `threadId`. A count that disagreed with the rows beneath\nit would be a third number for the same set."
+            "description": "How much the query matches, over the whole scope. Exact: no page size bounds\nit, no cursor narrows it, so it is the same number on the first page and the\nlast. Present only when `count=true`.\n\nEach operation counts what it lists. `searchThreads` lists messages of one\nmailbox and counts messages. `listAllThreads` counts CONVERSATIONS across\nevery non-muted mailbox of every account — a thread holding two matching\nmessages counts once, and so does one message reachable through a real\nfolder and a virtual copy of it — because that is what the cross-account\nlisting renders after collapsing by `threadId`. A count that disagreed with\nthe rows beneath it would be a third number for the same set.\n\nAbsent when the query carries `senderTrust` or `dkimMismatch`, even with\n`count=true`. Those are resolved by enriching rows rather than by a\npredicate, so no exact count exists short of enriching the whole mailbox.\nAbsence says so; a page's post-filter length labelled `count` would be a\npage length presented as a total. A client with no number renders none."
           }
         },
         "description": "Aggregate response for the filterable thread listings — `searchThreads` and\n`listAllThreads`. Carries the matching rows (`items`), a pagination\n`continuationToken`, and an optional `count` of what the query matches.\n`items` is omitted when `results=false` (count-only); `count` is present only\nwhen `count=true`. Thread-specific so the shared `ResultList<T>` (7 endpoints)\nstays untouched.\n\n`listAllThreads` answers with this model rather than `ResultList<T>` for that\nsame reason: it needs the count field and the shared model cannot carry one.\nOne model over both operations rather than a second of the same shape, so a\nclient reading a filtered thread listing reads one response type whether the\nlisting is scoped to a mailbox or spans every account."

package/package.json

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