@remit/api-openapi-types 0.0.107 → 0.0.109

package/package.json

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

package/types.d.ts

@@ -312,6 +312,26 @@ explained to the user as a failed delete.
      * Confidence of a placement verdict. `Confident` verdicts move mail (when the dark-ship flag is on); `Unsure` verdicts are recorded but never moved.
      */
     export type PlacementConfidence = "Confident" | "Unsure";
+    /**
+     * The stage 1 rule that let a message through without a spam check, when the sender decided it (RFC 041).
+     */
+    export type SpamSenderScreenRule = "ReportedSender" | "NeverSpam" | "Vip" | "WellKnown" | "Newsletter";
+    /**
+     * What the spam service tells Remit to do with a checked message (RFC 041).
+     */
+    export type SpamAction = "None" | "Warn" | "Junk";
+    /**
+     * What the spam service suspects a checked message of (RFC 041).
+     */
+    export type SpamKind = "Spam" | "Phishing";
+    /**
+     * 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" | "ListedPhishingLink" | "BackendSymbol";
+    /**
+     * Why a spam service gave no verdict (RFC 041).
+     */
+    export type SpamFailureKind = "Unreachable" | "TimedOut" | "ServiceError" | "Unparseable";
     /**
      * Where an attachment is between being promised and being sendable.
 
@@ -424,6 +444,10 @@ distinguishable from a network failure without parsing prose.
      * Whether sync still retries a warned message. Derived from stage and attempts, never stored.
      */
     export type SyncWarningState = "Retrying" | "GaveUp";
+    /**
+     * What the owner's mail provider said about a message, as the spam request carries it (RFC 041).
+     */
+    export type ProviderSpamVerdict = "Spam" | "Clean" | "Absent";
     /**
      * Explicit state engine for a pending placement-move marker (issue #1271, epic #1281). Recovery keys off this field, not control-flow inference: a redelivered/retried call drives a marker forward from whichever state it is actually in, rather than re-deriving intent by comparing the message's current location.
      */
@@ -4806,6 +4830,10 @@ every reader of either would otherwise narrow on the kind first.
        * Remit's placement verdict for this message, projected from the underlying Message row. Absent for a message judged before placement verdicts were recorded, or one Remit left in place.
        */
       placementVerdict?: MessagePlacementVerdict;
+      /**
+       * 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;
     }
     /**
      * 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.
@@ -4919,6 +4947,71 @@ every reader of either would otherwise narrow on the kind first.
        */
       decidedAt: number;
     }
+    /**
+     * No spam check has run on this message.
+     */
+    export interface SpamVerdictNotChecked {
+      state: "NotChecked";
+    }
+    /**
+     * Stage 1 let the message through without a call to the spam service.
+     */
+    export interface SpamVerdictScreenedOut {
+      state: "ScreenedOut";
+      screen: SpamScreenBySender | SpamScreenByFilter;
+    }
+    /**
+     * The sender's standing let the message through.
+     */
+    export interface SpamScreenBySender {
+      rule: SpamSenderScreenRule;
+    }
+    /**
+     * One of the owner's filters matched the message.
+     */
+    export interface SpamScreenByFilter {
+      rule: "Filter";
+      filterId: UUID;
+    }
+    /**
+     * A spam service weighed the message.
+     */
+    export interface SpamChecked {
+      state: "Checked";
+      score: number;
+      action: SpamAction;
+      kind: SpamKind;
+      reasons: SpamReason[];
+      /**
+       * The service called a model, so Remit counts the call against the daily cap.
+       */
+      modelCalled: boolean;
+    }
+    /**
+     * One check that found something, shaped like an rspamd symbol.
+     */
+    export interface SpamReason {
+      name: SpamReasonName;
+      /**
+       * The backend's own name for the check, as rspamd names a symbol. The inline engine uses `name`; a backend whose symbol has no `SpamReasonName` sends `BackendSymbol` and its raw symbol here.
+       */
+      symbol: string;
+      /**
+       * What the check added to the score.
+       */
+      score: number;
+      /**
+       * What the check found, such as the domain behind a link.
+       */
+      options: string[];
+    }
+    /**
+     * A spam service gave no verdict.
+     */
+    export interface SpamFailed {
+      state: "Failed";
+      kind: SpamFailureKind;
+    }
     /**
      * A page of thread messages.
      */
@@ -5941,6 +6034,10 @@ either way and cannot tell which it received.
        * Recorded when the user reported this message as spam. Absent means never reported, or reported and then undone (`POST /messages/not-spam` clears it). Independent of the message's current folder — deliberately not derived from "sits in Junk", which is also true of a message Remit moved on its own.
        */
       spamReport?: MessageSpamReport;
+      /**
+       * 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;
       createdAt: number;
       updatedAt: number;
     }
@@ -6128,6 +6225,10 @@ either way and cannot tell which it received.
        * Recorded when the user reported this message as spam. Absent means never reported, or reported and then undone (`POST /messages/not-spam` clears it). Independent of the message's current folder — deliberately not derived from "sits in Junk", which is also true of a message Remit moved on its own.
        */
       spamReport?: MessageSpamReport;
+      /**
+       * 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;
       createdAt: number;
       updatedAt: number;
       /**
@@ -6175,6 +6276,10 @@ either way and cannot tell which it received.
        * Structured sender-authenticity signal derived from DKIM headers at classification time. Absent for messages classified before this field was introduced — absence means no signal.
        */
       authenticity?: MessageAuthenticity;
+      /**
+       * 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;
       /**
        * Message-ID header value for quick reference
        */
@@ -7131,6 +7236,131 @@ of copying it, and so a person can see what was imported after the fact.
       createdAt: number;
       updatedAt: number;
     }
+    /**
+     * One header line, name and unfolded value.
+     */
+    export interface SpamHeader {
+      name: string;
+      value: string;
+    }
+    /**
+     * One link in the message body: where it points, and the text the reader sees.
+     */
+    export interface SpamLink {
+      href: string;
+      text: string;
+    }
+    /**
+     * The message as Remit parsed it once, so a backend needs no MIME parser.
+     */
+    export interface SpamRequestMessage {
+      /**
+       * The RFC 822 message, base64.
+       */
+      raw: string;
+      headers: SpamHeader[];
+      text: string;
+      html: string;
+      links: SpamLink[];
+    }
+    /**
+     * Envelope facts, as rspamd's `/checkv2` takes them.
+     */
+    export interface SpamRequestEnvelope {
+      /**
+       * The Return-Path address, or empty.
+       */
+      mailFrom: string;
+      /**
+       * The account's own addresses.
+       */
+      rcpt: string[];
+      /**
+       * The sending server's IP: the hop the provider's SPF check judged, else the first hop from a public address, or empty.
+       */
+      ip: string;
+      /**
+       * The HELO name the sending server gave, or empty.
+       */
+      helo: string;
+      /**
+       * The sending server's reverse DNS name as the receiving server recorded it, or empty.
+       */
+      hostname: string;
+    }
+    /**
+     * The provider's authentication results, read from its Authentication-Results.
+     */
+    export interface SpamRequestAuthentication {
+      dmarc: AuthResultVerdict;
+      spf: AuthResultVerdict;
+      dkim: AuthResultVerdict;
+      /**
+       * Registrable domain of the first passing DKIM signature, or `unverified` when no signature passed.
+       */
+      signerDomain: string;
+      /**
+       * The SPF-checked envelope domain, or empty.
+       */
+      envelopeDomain: string;
+    }
+    /**
+     * The owner's mail provider's own spam verdict.
+     */
+    export interface SpamRequestProvider {
+      verdict: ProviderSpamVerdict;
+      /**
+       * The score the provider's header carries, or empty.
+       */
+      score: string;
+      /**
+       * X-Spam-* and the like.
+       */
+      headers: SpamHeader[];
+    }
+    /**
+     * What Remit knows about the sender and the account. The spam service never reads Remit's database, so every fact it weighs arrives here.
+     */
+    export interface SpamRequestContext {
+      /**
+       * The owner has sent mail to this address.
+       */
+      knownSender: boolean;
+      /**
+       * Earlier messages from this address.
+       */
+      senderMessagesSeen: number;
+      /**
+       * Earlier messages from the address's registrable domain.
+       */
+      senderDomainMessagesSeen: number;
+      /**
+       * ISO 8601 date-time with offset the sender's registrable domain was registered, from RDAP. Absent when the registry publishes none or the lookup failed; Remit never fills in a placeholder.
+       */
+      senderDomainRegisteredAt?: string;
+      /**
+       * ISO 8601 date-time with offset the receiving server took the message (INTERNALDATE). Domain age is measured against it, so the judge stays a function of the request.
+       */
+      receivedAt: string;
+      /**
+       * The category classifier's answer, or empty.
+       */
+      classifierScores: ClassifierScore[];
+      /**
+       * The account has a model and is under its daily cap.
+       */
+      modelAllowed: boolean;
+    }
+    /**
+     * Everything a spam service weighs for one message (RFC 041). The shape follows rspamd's `/checkv2`: the raw message plus envelope facts as named fields.
+     */
+    export interface SpamRequest {
+      message: SpamRequestMessage;
+      envelope: SpamRequestEnvelope;
+      authentication: SpamRequestAuthentication;
+      provider: SpamRequestProvider;
+      context: SpamRequestContext;
+    }
     /**
      * 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
@@ -7255,6 +7485,34 @@ locally".
       createdAt: number;
       updatedAt: number;
     }
+    /**
+     * The registry published a registration date.
+     */
+    export interface DomainRegistrationPublished {
+      state: "Published";
+      /**
+       * ISO 8601 date-time with offset, as the registry's RDAP `registration` event states it.
+       */
+      registeredAt: string;
+    }
+    /**
+     * The registry answered and published no registration date, as DENIC does for .de.
+     */
+    export interface DomainRegistrationUnpublished {
+      state: "Unpublished";
+    }
+    /**
+     * A successful RDAP answer for one registrable domain, cached because a registration date never changes (RFC 041). A failed lookup is never cached.
+     */
+    export interface DomainRegistration {
+      /**
+       * The registrable domain (eTLD+1), lowercased. It is the row's identity: one row per domain.
+       */
+      domainRegistrationId: String256;
+      registration: DomainRegistrationPublished | DomainRegistrationUnpublished;
+      createdAt: number;
+      updatedAt: number;
+    }
     /**
      * How often this account has seen mail from one sender arrive under one DKIM
 signing identity. A third-party signer is not suspicious in itself — an ESP
@@ -11695,6 +11953,13 @@ export type AutoMovedInfo = Components.Schemas.AutoMovedInfo;
 export type LabelSummaryResponse = Components.Schemas.LabelSummaryResponse;
 export type MessageSpamReport = Components.Schemas.MessageSpamReport;
 export type MessagePlacementVerdict = Components.Schemas.MessagePlacementVerdict;
+export type SpamVerdictNotChecked = Components.Schemas.SpamVerdictNotChecked;
+export type SpamVerdictScreenedOut = Components.Schemas.SpamVerdictScreenedOut;
+export type SpamScreenBySender = Components.Schemas.SpamScreenBySender;
+export type SpamScreenByFilter = Components.Schemas.SpamScreenByFilter;
+export type SpamChecked = Components.Schemas.SpamChecked;
+export type SpamReason = Components.Schemas.SpamReason;
+export type SpamFailed = Components.Schemas.SpamFailed;
 export type ThreadMessageListResponse = Components.Schemas.ThreadMessageListResponse;
 export type ThreadSearchResponse = Components.Schemas.ThreadSearchResponse;
 export type CreateOutboxMessageInput = Components.Schemas.CreateOutboxMessageInput;
@@ -11769,9 +12034,20 @@ export type MailboxSpecialUseEntry = Components.Schemas.MailboxSpecialUseEntry;
 export type MailboxFlag = Components.Schemas.MailboxFlag;
 export type MailboxLock = Components.Schemas.MailboxLock;
 export type MessageFlag = Components.Schemas.MessageFlag;
+export type SpamHeader = Components.Schemas.SpamHeader;
+export type SpamLink = Components.Schemas.SpamLink;
+export type SpamRequestMessage = Components.Schemas.SpamRequestMessage;
+export type SpamRequestEnvelope = Components.Schemas.SpamRequestEnvelope;
+export type SpamRequestAuthentication = Components.Schemas.SpamRequestAuthentication;
+export type SpamRequestProvider = Components.Schemas.SpamRequestProvider;
+export type SpamRequestContext = Components.Schemas.SpamRequestContext;
+export type SpamRequest = Components.Schemas.SpamRequest;
 export type MessagePlacementMove = Components.Schemas.MessagePlacementMove;
 export type MessageFlagPush = Components.Schemas.MessageFlagPush;
 export type Envelope = Components.Schemas.Envelope;
+export type DomainRegistrationPublished = Components.Schemas.DomainRegistrationPublished;
+export type DomainRegistrationUnpublished = Components.Schemas.DomainRegistrationUnpublished;
+export type DomainRegistration = Components.Schemas.DomainRegistration;
 export type SenderSignerStanding = Components.Schemas.SenderSignerStanding;
 export type BodyPartParameter = Components.Schemas.BodyPartParameter;
 export type BodyStructureRefetch = Components.Schemas.BodyStructureRefetch;
@@ -11850,6 +12126,11 @@ export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
 export type MessageMutation = Components.Schemas.MessageMutation;
 export type PlacementAction = Components.Schemas.PlacementAction;
 export type PlacementConfidence = Components.Schemas.PlacementConfidence;
+export type SpamSenderScreenRule = Components.Schemas.SpamSenderScreenRule;
+export type SpamAction = Components.Schemas.SpamAction;
+export type SpamKind = Components.Schemas.SpamKind;
+export type SpamReasonName = Components.Schemas.SpamReasonName;
+export type SpamFailureKind = Components.Schemas.SpamFailureKind;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
 export type AddressFlagKey = Components.Schemas.AddressFlagKey;
@@ -11876,6 +12157,7 @@ export type AccountSettingName = Components.Schemas.AccountSettingName;
 export type ConfigImportState = Components.Schemas.ConfigImportState;
 export type ConfigImportRefKind = Components.Schemas.ConfigImportRefKind;
 export type SyncWarningState = Components.Schemas.SyncWarningState;
+export type ProviderSpamVerdict = Components.Schemas.ProviderSpamVerdict;
 export type MessagePlacementMoveState = Components.Schemas.MessagePlacementMoveState;
 export type FlagPushOperation = Components.Schemas.FlagPushOperation;
 export type MessageFlagPushState = Components.Schemas.MessageFlagPushState;