@remit/api-openapi-types 0.0.23 → 0.0.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "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.
      */
@@ -2451,6 +2455,10 @@ standing to persist.
        * Labels applied to this message — filter-, organize-, and manually-applied alike (issue #26). Absent/empty means no label is applied.
        */
       labels?: LabelSummaryResponse[];
+      /**
+       * Present when the user reported this message as spam and the report has not been undone, projected from the underlying Message row. Backs the "Reported as spam · Undo" affordance in list views.
+       */
+      spamReport?: MessageSpamReport;
     }
     /**
      * 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.
@@ -2468,6 +2476,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.
@@ -2502,6 +2518,15 @@ standing to persist.
       name: String140;
       color: LabelColor;
     }
+    /**
+     * Recorded when the user reported this message as spam via `POST /messages/report-spam`. Present means the report stands; absent means never reported, or reported and then undone via `POST /messages/not-spam` (which clears it). Backs the "Reported as spam · Undo" affordance independent of the message's current folder — the underlying move can settle, fail, or no-op (already in Junk) without changing whether the report itself is shown.
+     */
+    export interface MessageSpamReport {
+      /**
+       * Timestamp (epoch millis) the report was made.
+       */
+      reportedAt: number;
+    }
     /**
      * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
 pagination `continuationToken`, and an optional `count` of every message the
@@ -3228,6 +3253,10 @@ present only when `count=true`. Thread-specific so the shared `ResultList<T>`
        * Body-sync timestamp (epoch millis) the classifier's placement verdict was first decided, whether the verdict was to move the message or to leave it in place. Absent means placement has never been evaluated for this message. Guards `computePlacement` against a re-entrant body-sync pass (`fetchAndGetBody`'s `NoSuchKey` fallback, `syncBodies(..., force: true)`) re-deciding — and possibly reversing — a placement a user has since overridden by hand. `movedByRemit` remains the guard for a message that was placement-decided before this field existed.
        */
       placementDecidedAt?: number;
+      /**
+       * 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;
       createdAt: number;
       updatedAt: number;
     }
@@ -3355,6 +3384,10 @@ present only when `count=true`. Thread-specific so the shared `ResultList<T>`
        * Labels applied to this message — filter-, organize-, and manually-applied alike (issue #26). Absent/empty means no label is applied.
        */
       labels?: LabelSummaryResponse[];
+      /**
+       * Present when the user reported this message as spam and the report has not been undone. Backs the "Reported as spam · Undo" affordance.
+       */
+      spamReport?: MessageSpamReport;
     }
     /**
      * Message envelope (header metadata)
@@ -3727,6 +3760,36 @@ present only when `count=true`. Thread-specific so the shared `ResultList<T>`
        */
       action: LabelAction;
     }
+    /**
+     * Result of a report-spam or not-spam bulk call. Extends the standard counts with a reason per failed message: a partial failure here is an expected, routine outcome (a move from a prior press still settling) the client should be able to explain, not just count.
+     */
+    export interface SpamReportBulkResult {
+      /**
+       * Number of items accepted for processing
+       */
+      successCount: number;
+      /**
+       * Number of items rejected before processing
+       */
+      failureCount: number;
+      /**
+       * One entry per message that failed, naming why. Absent or empty when every message succeeded.
+       */
+      failures?: SpamReportFailure[];
+    }
+    /**
+     * One message's failure reason within a report-spam or not-spam bulk call.
+     */
+    export interface SpamReportFailure {
+      /**
+       * The message that failed
+       */
+      messageId: UUID;
+      /**
+       * Why it failed, safe to show the user as-is. One of a small allowlisted set of user-facing messages (e.g. "has not settled yet" while a prior move is still in flight) — never a raw internal error, which is logged server-side instead and never returned here. Not intended to be parsed programmatically.
+       */
+      reason: string;
+    }
     /**
      * Junction table linking envelope addresses to normalized addresses. Stores per-message display name since it may vary.
      */
@@ -4800,6 +4863,18 @@ declare namespace Paths {
       export type $200 = void;
     }
   }
+  namespace ReportSpam {
+    export type RequestBody = Components.Schemas.BulkMessageInput;
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
+  namespace NotSpam {
+    export type RequestBody = Components.Schemas.BulkMessageInput;
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
 }
 
 export interface OperationMethods {
@@ -5283,6 +5358,22 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
     data?: Paths.UpdateMessageLabels.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.UpdateMessageLabels.Responses.$200>;
+  /**
+   * reportSpam - Report messages as spam: block the sender (Address.flags.blocked) and move each message to the account's Junk folder. Skips the block (but still moves the message) when the sender is the account's own address. One call replaces composing the old separate `Block` and `Mark spam` actions — a single user intent, a single failure story. The sender block is written first and does not wait on the move; a failed move never rolls it back. Idempotent under a repeated call.
+   */
+  'reportSpam'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.ReportSpam.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.ReportSpam.Responses.$200>;
+  /**
+   * notSpam - Undo a spam report: clear the sender's `blocked` flag (never promotes to trusted/wellknown) and move each message back to `Message.originalMailboxId`. Idempotent under a repeated call. Each message is processed independently and concurrently, so the request's total wait is bounded by one message's settle timeout rather than accumulating across the batch.
+   */
+  'notSpam'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.NotSpam.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.NotSpam.Responses.$200>;
 }
 
 export interface PathsDictionary {
@@ -5852,6 +5943,26 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.UpdateMessageLabels.Responses.$200>;
   };
+  ['/messages/report-spam']: {
+    /**
+     * reportSpam - Report messages as spam: block the sender (Address.flags.blocked) and move each message to the account's Junk folder. Skips the block (but still moves the message) when the sender is the account's own address. One call replaces composing the old separate `Block` and `Mark spam` actions — a single user intent, a single failure story. The sender block is written first and does not wait on the move; a failed move never rolls it back. Idempotent under a repeated call.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.ReportSpam.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.ReportSpam.Responses.$200>;
+  };
+  ['/messages/not-spam']: {
+    /**
+     * notSpam - Undo a spam report: clear the sender's `blocked` flag (never promotes to trusted/wellknown) and move each message back to `Message.originalMailboxId`. Idempotent under a repeated call. Each message is processed independently and concurrently, so the request's total wait is bounded by one message's settle timeout rather than accumulating across the batch.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.NotSpam.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.NotSpam.Responses.$200>;
+  };
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>;
@@ -5922,6 +6033,7 @@ export type ThreadMessageResponse = Components.Schemas.ThreadMessageResponse;
 export type MessageAuthenticity = Components.Schemas.MessageAuthenticity;
 export type AutoMovedInfo = Components.Schemas.AutoMovedInfo;
 export type LabelSummaryResponse = Components.Schemas.LabelSummaryResponse;
+export type MessageSpamReport = Components.Schemas.MessageSpamReport;
 export type ThreadSearchResponse = Components.Schemas.ThreadSearchResponse;
 export type SemanticSearchResult = Components.Schemas.SemanticSearchResult;
 export type CreateOutboxMessageInput = Components.Schemas.CreateOutboxMessageInput;
@@ -5962,6 +6074,8 @@ export type BulkMessageInput = Components.Schemas.BulkMessageInput;
 export type MoveMessagesInput = Components.Schemas.MoveMessagesInput;
 export type CopyMessagesInput = Components.Schemas.CopyMessagesInput;
 export type UpdateMessageLabelsInput = Components.Schemas.UpdateMessageLabelsInput;
+export type SpamReportBulkResult = Components.Schemas.SpamReportBulkResult;
+export type SpamReportFailure = Components.Schemas.SpamReportFailure;
 export type EnvelopeAddress = Components.Schemas.EnvelopeAddress;
 export type AccountSettingValue = Components.Schemas.AccountSettingValue;
 export type BooleanSetting = Components.Schemas.BooleanSetting;
@@ -6013,6 +6127,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;