@remit/api-openapi-types 0.0.47 → 0.0.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.47",
+  "version": "0.0.49",
   "type": "module",
   "main": "types.d.ts",
   "types": "types.d.ts",

package/types.d.ts

@@ -185,6 +185,14 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * 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. `ForeignAddress` — the name spells out an email address at a domain the sender does not send from. `Unrelated` — no relation. `NoClaim` — the name is empty, or is an address at the sending domain, so it claims no other identity.
      */
     export type DisplayNameCorrespondence = "Corresponds" | "Lookalike" | "ForeignAddress" | "Unrelated" | "NoClaim";
+    /**
+     * Message lifecycle status for move/delete operations
+     */
+    export type MessageStatus = "active" | "deleting" | "deleted" | "moving";
+    /**
+     * Sync status for message move/delete operations
+     */
+    export type MessageSyncStatus = "synced" | "pending" | "failed";
     /**
      * Actionable placement verdict — the direction Remit decided to move a message. `leave` is not represented: a left-in-place verdict means the placement sub-model is absent.
      */
@@ -213,14 +221,6 @@ member (naming the file, the size and the cap), so a refusal must be
 distinguishable from a network failure without parsing prose.
      */
     export type OutboxAttachmentRejectionReason = "EmptyFile" | "UnusableFilename" | "FileTooLarge" | "MessageTooLarge" | "TooManyAttachments" | "ReservationExpired" | "UploadMissing" | "SizeMismatch";
-    /**
-     * Message lifecycle status for move/delete operations
-     */
-    export type MessageStatus = "active" | "deleting" | "deleted" | "moving";
-    /**
-     * Sync status for message move/delete operations
-     */
-    export type MessageSyncStatus = "synced" | "pending" | "failed";
     /**
      * Sender-authenticity tier for a message, resolved at body-sync from the trusted Authentication-Results header and the sender's pair-keyed standing. First match wins, in tier order: `Impersonation`, `Aligned`, `Authenticated`, `Routine`, `NotChecked`, `Caution`. `NotEvaluated` is the sentinel for a message the derivation has never run on — it is the default and what every message written before this field existed carries, and it is distinct from `NotChecked`, which is a result.
      */
@@ -3362,6 +3362,14 @@ asking "is this slot free" never has to do the merging itself.
        * 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.
        */
       authenticity?: MessageAuthenticity;
+      /**
+       * 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.
+       */
+      status: MessageStatus;
+      /**
+       * 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.
+       */
+      syncStatus: MessageSyncStatus;
       /**
        * Account identifier attached at read time via a mailboxId→accountId map. Present on rows returned by `GET /threads`; absent on rows from per-mailbox endpoints (clients can resolve from the mailbox cache).
        */
@@ -3486,18 +3494,23 @@ listing is scoped to a mailbox or spans every account.
        */
       continuationToken?: String800;
       /**
-       * How much the query matches, over the whole scope and independent of `limit`.
-Present only when `count=true`.
+       * How much the query matches, over the whole scope. Exact: no page size bounds
+it, no cursor narrows it, so it is the same number on the first page and the
+last. Present only when `count=true`.
 
 Each operation counts what it lists. `searchThreads` lists messages of one
-mailbox and counts messages; with `senderTrust` or `dkimMismatch` in the
-query that count is over the enriched window instead, since those are
-resolved off the row. `listAllThreads` counts CONVERSATIONS across every
-non-muted mailbox of every account — a thread holding two matching messages
-counts once, and so does one message reachable through a real folder and a
-virtual copy of it — because that is what the cross-account listing renders
-after collapsing by `threadId`. A count that disagreed with the rows beneath
-it would be a third number for the same set.
+mailbox and counts messages. `listAllThreads` counts CONVERSATIONS across
+every non-muted mailbox of every account — a thread holding two matching
+messages counts once, and so does one message reachable through a real
+folder and a virtual copy of it — because that is what the cross-account
+listing renders after collapsing by `threadId`. A count that disagreed with
+the rows beneath it would be a third number for the same set.
+
+Absent when the query carries `senderTrust` or `dkimMismatch`, even with
+`count=true`. Those are resolved by enriching rows rather than by a
+predicate, so no exact count exists short of enriching the whole mailbox.
+Absence says so; a page's post-filter length labelled `count` would be a
+page length presented as a total. A client with no number renders none.
        */
       count?: number;
     }
@@ -4547,6 +4560,14 @@ either way and cannot tell which it received.
        * Message-ID header value for quick reference
        */
       messageIdHeader?: string;
+      /**
+       * Message lifecycle status for move/delete operations. Defaults to `active` (normal, visible).
+       */
+      status: MessageStatus;
+      /**
+       * 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.
+       */
+      syncStatus: MessageSyncStatus;
       /**
        * Structured sender-authenticity signal derived from DKIM headers at classification time. Absent for messages classified before this field was introduced — absence means no signal.
        */
@@ -8585,13 +8606,13 @@ export type StarColor = Components.Schemas.StarColor;
 export type MessageCategory = Components.Schemas.MessageCategory;
 export type SenderTrust = Components.Schemas.SenderTrust;
 export type DisplayNameCorrespondence = Components.Schemas.DisplayNameCorrespondence;
+export type MessageStatus = Components.Schemas.MessageStatus;
+export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
 export type PlacementAction = Components.Schemas.PlacementAction;
 export type SemanticSearchChunkType = Components.Schemas.SemanticSearchChunkType;
 export type OutboxMessageStatus = Components.Schemas.OutboxMessageStatus;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
-export type MessageStatus = Components.Schemas.MessageStatus;
-export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
 export type AuthenticityVerdict = Components.Schemas.AuthenticityVerdict;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;
 export type PlacementConfidence = Components.Schemas.PlacementConfidence;