@remit/api-openapi-types 0.0.97 → 0.0.98

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +39 -35
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-types",
3
- "version": "0.0.97",
3
+ "version": "0.0.98",
4
4
  "type": "module",
5
5
  "main": "types.d.ts",
6
6
  "types": "types.d.ts",
package/types.d.ts CHANGED
@@ -292,6 +292,10 @@ explained to the user as a failed delete.
292
292
  * 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.
293
293
  */
294
294
  export type PlacementAction = "MoveToInbox" | "MoveToJunk";
295
+ /**
296
+ * Confidence of a placement verdict. `Confident` verdicts move mail (when the dark-ship flag is on); `Unsure` verdicts are recorded but never moved.
297
+ */
298
+ export type PlacementConfidence = "Confident" | "Unsure";
295
299
  /**
296
300
  * Where an attachment is between being promised and being sendable.
297
301
 
@@ -324,10 +328,6 @@ distinguishable from a network failure without parsing prose.
324
328
  * Authentication verdict for a single auth mechanism, as reported in the Authentication-Results header.
325
329
  */
326
330
  export type AuthResultVerdict = "Pass" | "Fail" | "None" | "Neutral" | "Softfail";
327
- /**
328
- * Confidence of a placement verdict. `Confident` verdicts move mail (when the dark-ship flag is on); `Unsure` verdicts are recorded but never moved.
329
- */
330
- export type PlacementConfidence = "Confident" | "Unsure";
331
331
  /**
332
332
  * Address roles in message headers per RFC 2822 Sections 3.6.2 and 3.6.3
333
333
  */
@@ -4579,6 +4579,10 @@ every reader of either would otherwise narrow on the kind first.
4579
4579
  * 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.
4580
4580
  */
4581
4581
  spamReport?: MessageSpamReport;
4582
+ /**
4583
+ * 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.
4584
+ */
4585
+ placementVerdict?: MessagePlacementVerdict;
4582
4586
  }
4583
4587
  /**
4584
4588
  * 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.
@@ -4663,6 +4667,35 @@ every reader of either would otherwise narrow on the kind first.
4663
4667
  */
4664
4668
  reportedAt: number;
4665
4669
  }
4670
+ /**
4671
+ * Remit's placement decision for a message, recorded at body-sync time. Present only when Remit decided to act (action != leave); absent when the message was left in place or synced before placement rolled out. Written in dry-run too, so the dark-ship verdict distribution is queryable before moves are enabled.
4672
+ */
4673
+ export interface MessagePlacementVerdict {
4674
+ /**
4675
+ * The direction Remit decided to move the message.
4676
+ */
4677
+ action: PlacementAction;
4678
+ /**
4679
+ * Confidence of the verdict. A Junk arrival not judged junk moves to the Inbox at either confidence, and one judged junk stays in Junk. Outside Junk only a `Confident` verdict moves the message.
4680
+ */
4681
+ confidence: PlacementConfidence;
4682
+ /**
4683
+ * The folder the message was in when the verdict was made: inbox | junk | other.
4684
+ */
4685
+ fromPlacement: string;
4686
+ /**
4687
+ * Deterministic signals the verdict was based on, for diagnostics.
4688
+ */
4689
+ reasons: string[];
4690
+ /**
4691
+ * True when the dark-ship flag was off, so the move was computed but not enqueued (would-move only). False when a real IMAP move was enqueued.
4692
+ */
4693
+ dryRun: boolean;
4694
+ /**
4695
+ * Body-sync timestamp the verdict was decided at (epoch millis).
4696
+ */
4697
+ decidedAt: number;
4698
+ }
4666
4699
  /**
4667
4700
  * A page of thread messages.
4668
4701
  */
@@ -5718,35 +5751,6 @@ either way and cannot tell which it received.
5718
5751
  */
5719
5752
  source?: string;
5720
5753
  }
5721
- /**
5722
- * Remit's placement decision for a message, recorded at body-sync time. Present only when Remit decided to act (action != leave); absent when the message was left in place or synced before placement rolled out. Written in dry-run too, so the dark-ship verdict distribution is queryable before moves are enabled.
5723
- */
5724
- export interface MessagePlacementVerdict {
5725
- /**
5726
- * The direction Remit decided to move the message.
5727
- */
5728
- action: PlacementAction;
5729
- /**
5730
- * Confidence of the verdict. A Junk arrival not judged junk moves to the Inbox at either confidence, and one judged junk stays in Junk. Outside Junk only a `Confident` verdict moves the message.
5731
- */
5732
- confidence: PlacementConfidence;
5733
- /**
5734
- * The folder the message was in when the verdict was made: inbox | junk | other.
5735
- */
5736
- fromPlacement: string;
5737
- /**
5738
- * Deterministic signals the verdict was based on, for diagnostics.
5739
- */
5740
- reasons: string[];
5741
- /**
5742
- * True when the dark-ship flag was off, so the move was computed but not enqueued (would-move only). False when a real IMAP move was enqueued.
5743
- */
5744
- dryRun: boolean;
5745
- /**
5746
- * Body-sync timestamp the verdict was decided at (epoch millis).
5747
- */
5748
- decidedAt: number;
5749
- }
5750
5754
  /**
5751
5755
  * Recorded when a standing filter (RFC 034) moved this message at body-sync time. Present only for a real, index-time filter move, so the client can render the badge naming the destination, offer an undo back to the source folder, and link to the filter in Settings. A retroactive back-apply move attributes to no filter and never writes this (RFC 034 Decision 3.3).
5752
5756
  */
@@ -10576,6 +10580,7 @@ export type MessageAuthenticity = Components.Schemas.MessageAuthenticity;
10576
10580
  export type AutoMovedInfo = Components.Schemas.AutoMovedInfo;
10577
10581
  export type LabelSummaryResponse = Components.Schemas.LabelSummaryResponse;
10578
10582
  export type MessageSpamReport = Components.Schemas.MessageSpamReport;
10583
+ export type MessagePlacementVerdict = Components.Schemas.MessagePlacementVerdict;
10579
10584
  export type ThreadMessageListResponse = Components.Schemas.ThreadMessageListResponse;
10580
10585
  export type ThreadSearchResponse = Components.Schemas.ThreadSearchResponse;
10581
10586
  export type CreateOutboxMessageInput = Components.Schemas.CreateOutboxMessageInput;
@@ -10607,7 +10612,6 @@ export type DescribeMessageResponse = Components.Schemas.DescribeMessageResponse
10607
10612
  export type MessageRecord = Components.Schemas.MessageRecord;
10608
10613
  export type MessageAuthResult = Components.Schemas.MessageAuthResult;
10609
10614
  export type MessageProviderSpam = Components.Schemas.MessageProviderSpam;
10610
- export type MessagePlacementVerdict = Components.Schemas.MessagePlacementVerdict;
10611
10615
  export type MessageFilterMove = Components.Schemas.MessageFilterMove;
10612
10616
  export type Message = Components.Schemas.Message;
10613
10617
  export type MessageSummaryResponse = Components.Schemas.MessageSummaryResponse;
@@ -10725,13 +10729,13 @@ export type MessageStatus = Components.Schemas.MessageStatus;
10725
10729
  export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
10726
10730
  export type MessageMutation = Components.Schemas.MessageMutation;
10727
10731
  export type PlacementAction = Components.Schemas.PlacementAction;
10732
+ export type PlacementConfidence = Components.Schemas.PlacementConfidence;
10728
10733
  export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
10729
10734
  export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
10730
10735
  export type AddressFlagKey = Components.Schemas.AddressFlagKey;
10731
10736
  export type MessageClassificationState = Components.Schemas.MessageClassificationState;
10732
10737
  export type AuthenticityVerdict = Components.Schemas.AuthenticityVerdict;
10733
10738
  export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;
10734
- export type PlacementConfidence = Components.Schemas.PlacementConfidence;
10735
10739
  export type AddressRole = Components.Schemas.AddressRole;
10736
10740
  export type MediaType = Components.Schemas.MediaType;
10737
10741
  export type TransferEncoding = Components.Schemas.TransferEncoding;