@remit/api-openapi-types 0.0.112 → 0.0.114

package/package.json

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

package/types.d.ts

@@ -327,11 +327,15 @@ explained to the user as a failed delete.
     /**
      * The stable name of one check the spam service ran and found something with (RFC 041). A client holds one sentence per name.
      */
-    export type SpamReasonName = "DmarcFail" | "SignerMismatch" | "ReplyToMismatch" | "LinkTextMismatch" | "LinkDomainDistant" | "PunycodeDomain" | "MixedScriptDomain" | "ConfusableDomains" | "SingleOffDomainLink" | "GeneratedName" | "FirstContactDomain" | "RecentlyRegisteredDomain" | "UnknownRegistrationDate" | "ClassifierSpam" | "ClassifierPhishing" | "ProviderSpam" | "DisplayNameForeignAddress" | "DisplayNameLookalike" | "ModelImpersonation" | "ModelSpam" | "ModelClean" | "ListedPhishingLink" | "BackendSymbol";
+    export type SpamReasonName = "DmarcFail" | "DkimDmarcFail" | "SignerMismatch" | "ReplyToMismatch" | "LinkTextMismatch" | "LinkDomainDistant" | "PunycodeDomain" | "MixedScriptDomain" | "ConfusableDomains" | "SingleOffDomainLink" | "GeneratedName" | "FirstContactDomain" | "RecentlyRegisteredDomain" | "UnknownRegistrationDate" | "ClassifierSpam" | "ClassifierPhishing" | "ProviderSpam" | "DisplayNameForeignAddress" | "DisplayNameLookalike" | "ModelImpersonation" | "ModelSpam" | "ModelClean" | "ListedPhishingLink" | "BackendSymbol";
     /**
      * 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).
      */
@@ -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[];
     }
@@ -5063,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.
@@ -7484,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
@@ -12213,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;
@@ -12302,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;