@remit/api-openapi-types 0.0.110 → 0.0.112

package/package.json

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

package/types.d.ts

@@ -253,6 +253,10 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Why a classification provider cannot run.
      */
     export type ClassificationUnrunnableReason = "NoBaseUrl" | "NoApiKey";
+    /**
+     * What a `Junk` verdict of one kind does (RFC 041). The owner picks one for `Spam` and one for `Phishing`.
+     */
+    export type SpamLabelPlacement = "MoveToSpam" | "WarnOnly";
     /**
      * Why a classification provider call gave no usable answer.
      */
@@ -265,6 +269,14 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized`, which covers both a message that has not been classified yet and one the classifier declined to categorize; `Message.classificationState` is what tells those apart.
      */
     export type MessageCategory = "uncategorized" | "personal" | "newsletter" | "marketing" | "automated" | "transactional" | "social" | "coldOutreach";
+    /**
+     * 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";
     /**
      * Sort order for list operations
      */
@@ -277,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
      */
@@ -316,14 +324,6 @@ explained to the user as a failed delete.
      * 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.
      */
@@ -360,10 +360,6 @@ distinguishable from a network failure without parsing prose.
      * Whether the header classifier has examined a message's body (issue #331). Persistence-level state on `Message`, deliberately off the wire: no response model carries it. It exists because `category` cannot answer this question — `uncategorized` is both the value a metadata-synced row starts at and the answer the classifier gives when it has nothing to say, so a guard reading `category` alone cannot tell "never examined" from "examined and declined" and re-reads the stored body on every sync pass forever.
      */
     export type MessageClassificationState = "NotExamined" | "Examined";
-    /**
-     * 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.
-     */
-    export type AuthenticityVerdict = "NotEvaluated" | "NotChecked" | "Aligned" | "Authenticated" | "Routine" | "Caution" | "Impersonation";
     /**
      * Authentication verdict for a single auth mechanism, as reported in the Authentication-Results header.
      */
@@ -439,7 +435,7 @@ distinguishable from a network failure without parsing prose.
     /**
      * Known user-setting keys. Each maps, in the registry, to a required value kind and a zod schema. New keys are added deliberately by extending this enum and the registry — never as an ad-hoc column.
      */
-    export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "FolderRoleAppointmentLabel" | "MailboxRole" | "DefaultInvitationSenderAccountId" | "ClassificationPresetId" | "ClassificationModel" | "ClassificationBaseUrl" | "ClassificationApiKey" | "ClassificationEnabled" | "ClassificationDailyLimit" | "ClassificationUsage";
+    export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "FolderRoleAppointmentLabel" | "MailboxRole" | "DefaultInvitationSenderAccountId" | "ClassificationPresetId" | "ClassificationModel" | "ClassificationBaseUrl" | "ClassificationApiKey" | "ClassificationEnabled" | "ClassificationDailyLimit" | "ClassificationUsage" | "SpamPlacementSpam" | "SpamPlacementPhishing";
     /**
      * Lifecycle of one applied configuration import. An import is Complete the moment every folder reference in the file has been bound to a real mailbox; until then it is Pending, waiting on the IMAP discovery that will produce those mailboxes.
      */
@@ -448,6 +444,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.
      */
@@ -3861,6 +3861,10 @@ field on this resource rather than one more operation.
        * The classification provider in effect, `Unrunnable` when one is chosen but cannot run, or `NotConfigured`.
        */
       classification: ClassificationNotConfigured | ClassificationConfigured | ClassificationUnrunnable;
+      /**
+       * How Remit acts on spam verdicts.
+       */
+      spam: SpamSettings;
     }
     /**
      * A classification provider the reader can pick.
@@ -3987,6 +3991,37 @@ field on this resource rather than one more operation.
       presetId: ClassificationPresetId;
       reason: ClassificationUnrunnableReason;
     }
+    /**
+     * How Remit acts on spam verdicts for the caller.
+     */
+    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.
+       */
+      thresholds: SpamThresholdsUnset | SpamThresholdsSet;
+      /**
+       * What a `Junk` verdict of kind `Spam` does.
+       */
+      spamPlacement: SpamLabelPlacement;
+      /**
+       * What a `Junk` verdict of kind `Phishing` does.
+       */
+      phishingPlacement: SpamLabelPlacement;
+    }
+    /**
+     * No thresholds are set, so every verdict's action is `None` 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.
+     */
+    export interface SpamThresholdsSet {
+      state: "Set";
+      cleanBelow: number;
+      spamAt: number;
+    }
     /**
      * A change to the caller's settings. Every field is optional and absence means untouched.
      */
@@ -4019,6 +4054,14 @@ field on this resource rather than one more operation.
        * The most classification calls per mail account per UTC day. Needs a provider in effect, saved or inherited.
        */
       classificationDailyLimit?: number;
+      /**
+       * What a `Junk` verdict of kind `Spam` does: move the message to Junk, or warn only. Applies to mail arriving from now on.
+       */
+      spamPlacementSpam?: SpamLabelPlacement;
+      /**
+       * What a `Junk` verdict of kind `Phishing` does: move the message to Junk, or warn only. Applies to mail arriving from now on.
+       */
+      spamPlacementPhishing?: SpamLabelPlacement;
     }
     /**
      * The classification provider form as it stands, saved or not.
@@ -4100,6 +4143,14 @@ field on this resource rather than one more operation.
        */
       byLabel: ClassifierLabelCount[];
       corrections: ClassifierCorrections;
+      /**
+       * Spam verdicts of action `Warn` or `Junk` per arrival day, action and kind, in date order. A day with none is absent.
+       */
+      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.
+       */
+      spamScoreBands: SpamScoreBand[];
     }
     /**
      * Examined messages in one category.
@@ -4128,6 +4179,28 @@ field on this resource rather than one more operation.
        */
       categoryOverridden: number;
     }
+    /**
+     * Spam verdicts on mail that arrived on one day, for one action and kind.
+     */
+    export interface SpamDayCount {
+      /**
+       * The arrival day, YYYY-MM-DD, in the zone offset of `since`.
+       */
+      date: string;
+      /**
+       * `Warn` or `Junk`: the judge's action, before the owner's per-label setting.
+       */
+      action: SpamAction;
+      kind: SpamKind;
+      count: number;
+    }
+    /**
+     * Checked messages whose spam score falls in one band, `from` inclusive to `from + 0.05` exclusive; the last band includes 1.
+     */
+    export interface SpamScoreBand {
+      from: number;
+      count: number;
+    }
     /**
      * Tasks due in the requested window, in due order. Unpaginated: the window is the bound.
      */
@@ -4819,9 +4892,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.
        */
@@ -4842,6 +4915,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.
@@ -4859,14 +4936,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.
        */
@@ -6002,10 +6071,6 @@ 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;
-      /**
-       * Sender-authenticity tier resolved at body-sync. Defaults to `NotEvaluated`, the named pending state every message written before the derivation existed carries. Top-level rather than a member of `authenticity` on purpose: that blob is absent for all unsigned mail, so a guard keyed on its absence cannot tell "never derived" from "nothing to derive" and would re-derive unsigned mail forever.
-       */
-      authenticityVerdict: AuthenticityVerdict;
       /**
        * Provider authentication-results signal parsed from Authentication-Results header. Absent for messages synced before this field was introduced.
        */
@@ -6046,6 +6111,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;
     }
@@ -6193,10 +6262,6 @@ 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;
-      /**
-       * Sender-authenticity tier resolved at body-sync. Defaults to `NotEvaluated`, the named pending state every message written before the derivation existed carries. Top-level rather than a member of `authenticity` on purpose: that blob is absent for all unsigned mail, so a guard keyed on its absence cannot tell "never derived" from "nothing to derive" and would re-derive unsigned mail forever.
-       */
-      authenticityVerdict: AuthenticityVerdict;
       /**
        * Provider authentication-results signal parsed from Authentication-Results header. Absent for messages synced before this field was introduced.
        */
@@ -6237,6 +6302,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;
       /**
@@ -6288,6 +6357,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
        */
@@ -9566,7 +9639,7 @@ reader organizes the event, none otherwise.
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.TestClassificationProvider.Responses.$200>;
   /**
-   * ClassificationStatsOperations_getClassificationStats - Count what the classifier decided for mail that arrived on or after `since`, and how often the reader corrected it. Refused with 400 when `since` is not an ISO 8601 date-time with zone offset.
+   * ClassificationStatsOperations_getClassificationStats - Count what the classifier and the spam service decided for mail that arrived on or after `since`, and how often the reader corrected it. Refused with 400 when `since` is not an ISO 8601 date-time with zone offset.
    */
   'ClassificationStatsOperations_getClassificationStats'(
     parameters?: Parameters<Paths.GetClassificationStats.QueryParameters> | null,
@@ -10562,7 +10635,7 @@ reader organizes the event, none otherwise.
   };
   ['/classification-stats']: {
     /**
-     * ClassificationStatsOperations_getClassificationStats - Count what the classifier decided for mail that arrived on or after `since`, and how often the reader corrected it. Refused with 400 when `since` is not an ISO 8601 date-time with zone offset.
+     * ClassificationStatsOperations_getClassificationStats - Count what the classifier and the spam service decided for mail that arrived on or after `since`, and how often the reader corrected it. Refused with 400 when `since` is not an ISO 8601 date-time with zone offset.
      */
     'get'(
       parameters?: Parameters<Paths.GetClassificationStats.QueryParameters> | null,
@@ -12013,6 +12086,9 @@ export type ClassificationSources = Components.Schemas.ClassificationSources;
 export type ClassificationUsage = Components.Schemas.ClassificationUsage;
 export type ClassificationCostPriced = Components.Schemas.ClassificationCostPriced;
 export type ClassificationUnrunnable = Components.Schemas.ClassificationUnrunnable;
+export type SpamSettings = Components.Schemas.SpamSettings;
+export type SpamThresholdsUnset = Components.Schemas.SpamThresholdsUnset;
+export type SpamThresholdsSet = Components.Schemas.SpamThresholdsSet;
 export type UpdateUserSettingsInput = Components.Schemas.UpdateUserSettingsInput;
 export type ClassificationTestInput = Components.Schemas.ClassificationTestInput;
 export type ClassificationTestPassed = Components.Schemas.ClassificationTestPassed;
@@ -12021,6 +12097,8 @@ export type ClassifierStats = Components.Schemas.ClassifierStats;
 export type ClassifierCategoryCount = Components.Schemas.ClassifierCategoryCount;
 export type ClassifierLabelCount = Components.Schemas.ClassifierLabelCount;
 export type ClassifierCorrections = Components.Schemas.ClassifierCorrections;
+export type SpamDayCount = Components.Schemas.SpamDayCount;
+export type SpamScoreBand = Components.Schemas.SpamScoreBand;
 export type CalendarTaskListResponse = Components.Schemas.CalendarTaskListResponse;
 export type CalendarTask = Components.Schemas.CalendarTask;
 export type CalendarTaskResponse = Components.Schemas.CalendarTaskResponse;
@@ -12207,21 +12285,21 @@ export type ClassificationPresetGroup = Components.Schemas.ClassificationPresetG
 export type ClassificationAdapterShape = Components.Schemas.ClassificationAdapterShape;
 export type ClassificationValueSource = Components.Schemas.ClassificationValueSource;
 export type ClassificationUnrunnableReason = Components.Schemas.ClassificationUnrunnableReason;
+export type SpamLabelPlacement = Components.Schemas.SpamLabelPlacement;
 export type ClassificationFailureKind = Components.Schemas.ClassificationFailureKind;
 export type ClassificationField = Components.Schemas.ClassificationField;
 export type MessageCategory = Components.Schemas.MessageCategory;
+export type SpamAction = Components.Schemas.SpamAction;
+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;
 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 SpamModelOutcome = Components.Schemas.SpamModelOutcome;
 export type SpamFailureKind = Components.Schemas.SpamFailureKind;
@@ -12229,7 +12307,6 @@ export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
 export type AddressFlagKey = Components.Schemas.AddressFlagKey;
 export type MessageClassificationState = Components.Schemas.MessageClassificationState;
-export type AuthenticityVerdict = Components.Schemas.AuthenticityVerdict;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;
 export type AddressRole = Components.Schemas.AddressRole;
 export type MediaType = Components.Schemas.MediaType;
@@ -12251,6 +12328,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;