@remit/api-openapi-types 0.0.22 → 0.0.24

package/package.json

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

package/types.d.ts

@@ -141,6 +141,10 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Trust level for the From address, derived at read time from AddressFlags + counters.
      */
     export type SenderTrust = "unknown" | "wellknown" | "vip";
+    /**
+     * 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.
+     */
+    export type DisplayNameCorrespondence = "Corresponds" | "Lookalike" | "Unrelated" | "NoClaim";
     /**
      * 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.
      */
@@ -2468,6 +2472,14 @@ standing to persist.
        * True when DKIM signing domain(s) are present and none aligns with the From domain
        */
       dkimMismatch: boolean;
+      /**
+       * 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.
+       */
+      displayNameCorrespondence?: DisplayNameCorrespondence;
+      /**
+       * 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.
+       */
+      offDomainLinkDomains?: string[];
     }
     /**
      * Present only when Remit auto-moved this message on body-sync. Two shapes share this model: a classifier placement move carries `action` + `fromPlacement` (Inbox/Junk direction); a standing-filter move carries `fromMailboxId` + `destinationMailboxId` + `filterId` (an arbitrary destination folder). Absent means the message was not auto-moved by Remit — clients treat absence as no indicator.
@@ -2504,10 +2516,10 @@ standing to persist.
     }
     /**
      * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
-pagination `continuationToken`, and an optional `count` of matches within the
-server-capped window. `items` is omitted when `results=false` (count-only);
-`count` is present only when `count=true`. Thread-specific so the shared
-`ResultList<T>` (7 endpoints) stays untouched.
+pagination `continuationToken`, and an optional `count` of every message the
+query matches. `items` is omitted when `results=false` (count-only); `count` is
+present only when `count=true`. Thread-specific so the shared `ResultList<T>`
+(7 endpoints) stays untouched.
      */
     export interface ThreadSearchResponse {
       /**
@@ -2519,7 +2531,7 @@ server-capped window. `items` is omitted when `results=false` (count-only);
        */
       continuationToken?: String800;
       /**
-       * Number of matches within the server-capped window. Present only when `count=true`.
+       * 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.
        */
       count?: number;
     }
@@ -6013,6 +6025,7 @@ export type SortOrder = Components.Schemas.SortOrder;
 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 PlacementAction = Components.Schemas.PlacementAction;
 export type SemanticSearchChunkType = Components.Schemas.SemanticSearchChunkType;
 export type OutboxMessageStatus = Components.Schemas.OutboxMessageStatus;