@remit/api-openapi-types 0.0.111 → 0.0.113

package/package.json

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

package/types.d.ts

@@ -289,10 +289,6 @@ 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. `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
      */
@@ -336,6 +332,10 @@ explained to the user as a failed delete.
      * What happened to the model call for one checked message (RFC 041 stage 3).
      */
     export type SpamModelOutcome = "Answered" | "NotConfigured" | "DailyLimit" | "RateLimited" | "OutOfBand";
+    /**
+     * One judge in the deployment's spam pipeline (RFC 041). The judges run in the configured order until one is sure.
+     */
+    export type SpamJudgeName = "Inline" | "Rspamd" | "Model";
     /**
      * Why a spam service gave no verdict (RFC 041).
      */
@@ -448,6 +448,10 @@ distinguishable from a network failure without parsing prose.
      * Which piece of configuration a still-unbound folder reference belongs to. A mailbox id is regenerated by every discovery, so an imported file names folders by IMAP path and the binder writes the row once a path resolves.
      */
     export type ConfigImportRefKind = "FolderRole" | "MailboxOverride" | "FilterAction";
+    /**
+     * 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";
     /**
      * Whether sync still retries a warned message. Derived from stage and attempts, never stored.
      */
@@ -3996,7 +4000,7 @@ field on this resource rather than one more operation.
      */
     export interface SpamSettings {
       /**
-       * The thresholds in effect. They come from the deployment (`SPAM_CLEAN_BELOW` and `SPAM_AT`). `Unset` when the deployment uses rspamd, which applies its own.
+       * The inline judge's thresholds, from the deployment's `SPAM_PIPELINE`. `Unset` when the pipeline has no inline judge.
        */
       thresholds: SpamThresholdsUnset | SpamThresholdsSet;
       /**
@@ -4009,13 +4013,13 @@ field on this resource rather than one more operation.
       phishingPlacement: SpamLabelPlacement;
     }
     /**
-     * No thresholds are set, so every verdict's action is `None` and nothing moves.
+     * No thresholds are set, so the judge's action is `None` and it is never sure: the next judge runs, and nothing moves.
      */
     export interface SpamThresholdsUnset {
       state: "Unset";
     }
     /**
-     * The two scores that turn a spam score into an action: below `cleanBelow` nothing happens, from `spamAt` up the message goes to Junk, and between the two the owner is warned.
+     * The two scores that turn a spam score into an action: below `cleanBelow` nothing happens, from `spamAt` up the message goes to Junk, and between the two the owner is warned. The judge is sure outside the band; inside it the next judge runs.
      */
     export interface SpamThresholdsSet {
       state: "Set";
@@ -4148,7 +4152,7 @@ field on this resource rather than one more operation.
        */
       spamByDay: SpamDayCount[];
       /**
-       * Checked messages per spam score band of width 0.05, lowest first. A band with none is absent. Summing the bands from a threshold up counts the messages that threshold reaches.
+       * Checked messages the inline judge decided, per spam score band of width 0.05, lowest first, so calibration reads inline scores only. A band with none is absent. Summing the bands from a threshold up counts the messages that threshold reaches.
        */
       spamScoreBands: SpamScoreBand[];
     }
@@ -4892,9 +4896,9 @@ every reader of either would otherwise narrow on the kind first.
        */
       abandonedMutation: MessageMutation;
       /**
-       * 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).
+       * The account that owns the message, resolved at read time from the row's mailbox. The ThreadMessage row has no column of its own.
        */
-      accountId?: UUID;
+      accountId: UUID;
       /**
        * Present only when Remit auto-moved this message on body-sync. Absent means the message was not auto-moved by Remit.
        */
@@ -4915,6 +4919,10 @@ every reader of either would otherwise narrow on the kind first.
        * The spam outcome of the underlying Message (RFC 041), projected at read time. `NotChecked` when the Message row is missing from the batch.
        */
       spamVerdict: SpamVerdictNotChecked | SpamVerdictScreenedOut | SpamChecked | SpamFailed;
+      /**
+       * True once the owner marked the underlying Message Not spam, projected at read time. While true, `spamVerdict` raises no warning. `false` when the Message row is missing from the batch.
+       */
+      spamCleared: boolean;
     }
     /**
      * 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.
@@ -4932,14 +4940,6 @@ every reader of either would otherwise narrow on the kind first.
        * 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. Display-only: it never decides placement. Present 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. Display-only: it never decides placement. An empty array means every link stayed on the sender's domain, absence means the comparison was never made.
-       */
-      offDomainLinkDomains?: string[];
       /**
        * Registrable domain of the first verified DKIM `header.d` in trusted Authentication-Results order, or the reserved literal `unverified` when no identity could be established. Unlike `dkimDomain`, which is the unverified `d=` claim the sender wrote, this is only set from a signature the trusted Authentication-Results reported as passing. Absent for messages classified before the field existed.
        */
@@ -5067,6 +5067,10 @@ every reader of either would otherwise narrow on the kind first.
        * What happened to the model call: `Answered`, or why no answer shaped the verdict.
        */
       modelOutcome: SpamModelOutcome;
+      /**
+       * The judge whose score and action stand: the first one that was sure, or the last one that ran. `reasons` holds every judge that ran.
+       */
+      decidedBy: SpamJudgeName;
     }
     /**
      * One check that found something, shaped like an rspamd symbol.
@@ -6115,6 +6119,10 @@ either way and cannot tell which it received.
        * The spam outcome for this message (RFC 041). Defaults to `NotChecked`; body sync records `ScreenedOut` when stage 1 let the message through, or the spam service's answer.
        */
       spamVerdict: SpamVerdictNotChecked | SpamVerdictScreenedOut | SpamChecked | SpamFailed;
+      /**
+       * True once the owner marked this message Not spam, until they report it as spam again. A cleared message carries no Spam or Phishing label, and a rescan records its verdict without labelling or moving it, so clients read this before `spamVerdict` and raise no warning while it is true.
+       */
+      spamCleared: boolean;
       createdAt: number;
       updatedAt: number;
     }
@@ -6302,6 +6310,10 @@ either way and cannot tell which it received.
        * The spam outcome for this message (RFC 041). Defaults to `NotChecked`; body sync records `ScreenedOut` when stage 1 let the message through, or the spam service's answer.
        */
       spamVerdict: SpamVerdictNotChecked | SpamVerdictScreenedOut | SpamChecked | SpamFailed;
+      /**
+       * True once the owner marked this message Not spam, until they report it as spam again. A cleared message carries no Spam or Phishing label, and a rescan records its verdict without labelling or moving it, so clients read this before `spamVerdict` and raise no warning while it is true.
+       */
+      spamCleared: boolean;
       createdAt: number;
       updatedAt: number;
       /**
@@ -6353,6 +6365,10 @@ either way and cannot tell which it received.
        * The spam outcome for this message (RFC 041). Defaults to `NotChecked`; body sync records `ScreenedOut` when stage 1 let the message through, or the spam service's answer.
        */
       spamVerdict: SpamVerdictNotChecked | SpamVerdictScreenedOut | SpamChecked | SpamFailed;
+      /**
+       * True once the owner marked this message Not spam, until they report it as spam again. A cleared message carries no Spam or Phishing label, and a rescan records its verdict without labelling or moving it, so clients read this before `spamVerdict` and raise no warning while it is true.
+       */
+      spamCleared: boolean;
       /**
        * Message-ID header value for quick reference
        */
@@ -7476,6 +7492,30 @@ of copying it, and so a person can see what was imported after the fact.
       provider: SpamRequestProvider;
       context: SpamRequestContext;
     }
+    /**
+     * The inline judge, with its own thresholds.
+     */
+    export interface SpamInlineJudgeConfig {
+      name: any;
+      thresholds: SpamThresholdsUnset | SpamThresholdsSet;
+    }
+    /**
+     * An rspamd judge. Its action is its verdict: `no action` and `Junk` actions are sure, softer ones pass the message on.
+     */
+    export interface SpamRspamdJudgeConfig {
+      name: any;
+      /**
+       * The rspamd normal worker's http or https URL.
+       */
+      url: string;
+    }
+    /**
+     * The model judge. It spends a unit of the daily model cap per call, so it always has thresholds.
+     */
+    export interface SpamModelJudgeConfig {
+      name: any;
+      thresholds: SpamThresholdsSet;
+    }
     /**
      * Pending-move marker for a Remit-driven placement move (issue #1271, epic
 #1281). Written in the SAME local step that moves a Message's `mailboxId` to
@@ -12205,6 +12245,9 @@ export type SpamRequestAuthentication = Components.Schemas.SpamRequestAuthentica
 export type SpamRequestProvider = Components.Schemas.SpamRequestProvider;
 export type SpamRequestContext = Components.Schemas.SpamRequestContext;
 export type SpamRequest = Components.Schemas.SpamRequest;
+export type SpamInlineJudgeConfig = Components.Schemas.SpamInlineJudgeConfig;
+export type SpamRspamdJudgeConfig = Components.Schemas.SpamRspamdJudgeConfig;
+export type SpamModelJudgeConfig = Components.Schemas.SpamModelJudgeConfig;
 export type MessagePlacementMove = Components.Schemas.MessagePlacementMove;
 export type MessageFlagPush = Components.Schemas.MessageFlagPush;
 export type Envelope = Components.Schemas.Envelope;
@@ -12286,7 +12329,6 @@ export type SpamKind = Components.Schemas.SpamKind;
 export type SortOrder = Components.Schemas.SortOrder;
 export type StarColor = Components.Schemas.StarColor;
 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 MessageMutation = Components.Schemas.MessageMutation;
@@ -12295,6 +12337,7 @@ export type PlacementConfidence = Components.Schemas.PlacementConfidence;
 export type SpamSenderScreenRule = Components.Schemas.SpamSenderScreenRule;
 export type SpamReasonName = Components.Schemas.SpamReasonName;
 export type SpamModelOutcome = Components.Schemas.SpamModelOutcome;
+export type SpamJudgeName = Components.Schemas.SpamJudgeName;
 export type SpamFailureKind = Components.Schemas.SpamFailureKind;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
@@ -12321,6 +12364,7 @@ export type SenderOverride = Components.Schemas.SenderOverride;
 export type AccountSettingName = Components.Schemas.AccountSettingName;
 export type ConfigImportState = Components.Schemas.ConfigImportState;
 export type ConfigImportRefKind = Components.Schemas.ConfigImportRefKind;
+export type DisplayNameCorrespondence = Components.Schemas.DisplayNameCorrespondence;
 export type SyncWarningState = Components.Schemas.SyncWarningState;
 export type ProviderSpamVerdict = Components.Schemas.ProviderSpamVerdict;
 export type MessagePlacementMoveState = Components.Schemas.MessagePlacementMoveState;