@remit/api-openapi-types 0.0.59 → 0.0.61

package/package.json

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

package/types.d.ts

@@ -239,7 +239,7 @@ distinguishable from a network failure without parsing prose.
     /**
      * Names a key of `AddressFlags` that a client may address in `PATCH /addresses/{addressId}`. `wellknown` is deliberately absent: it is server-owned, derived from engagement counters, and is never written or removed by a client.
      */
-    export type AddressFlagKey = "trusted" | "blocked" | "muted" | "vip" | "junkOnly" | "category" | "autoArchive" | "unsubscribed";
+    export type AddressFlagKey = "trusted" | "blocked" | "muted" | "vip" | "junkOnly" | "category" | "autoArchive" | "unsubscribed" | "neverSpam";
     /**
      * 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.
      */
@@ -316,6 +316,10 @@ distinguishable from a network failure without parsing prose.
      * Content encoding/compression types for stored content
      */
     export type ContentEncoding = "none" | "gzip" | "zstd";
+    /**
+     * What the user has instructed about a sender's placement, resolved from AddressFlags at read time. An instruction, not a heuristic signal: it outranks every DKIM/DMARC/provider verdict. `SenderTrust` stays a separate axis and is unaffected.
+     */
+    export type SenderOverride = "none" | "blocked" | "neverSpam";
     /**
      * 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.
      */
@@ -4274,6 +4278,7 @@ either way and cannot tell which it received.
     export interface AddressFlags {
       trusted?: TrustedFlag;
       blocked?: BlockedFlag;
+      neverSpam?: NeverSpamFlag;
       muted?: MutedFlag;
       vip?: VipFlag;
       wellknown?: WellknownFlag;
@@ -4326,6 +4331,28 @@ either way and cannot tell which it received.
       reason?: string;
       value: boolean;
     }
+    /**
+     * Sender is never spam: their mail is rescued from Junk whatever the authentication signals say. Mutually exclusive with `blocked` — the flag written last removes the other.
+     */
+    export interface NeverSpamFlag {
+      /**
+       * Timestamp when the flag was set
+       */
+      setAt: number;
+      /**
+       * Device/session/user identifier that set the flag (audit trail)
+       */
+      setBy?: string;
+      /**
+       * Optional auto-revoke timestamp
+       */
+      expiresAt?: number;
+      /**
+       * Free-text user note
+       */
+      reason?: string;
+      value: boolean;
+    }
     /**
      * Sender is VIP: priority surface and push escalation
      */
@@ -4532,6 +4559,10 @@ either way and cannot tell which it received.
     export interface UpdateAddressFlagsInput {
       trusted?: TrustedFlag | any;
       blocked?: BlockedFlag | any;
+      /**
+       * Setting this to `value: true` removes `blocked`, and setting `blocked` removes this one; the two cannot both stand
+       */
+      neverSpam?: NeverSpamFlag | any;
       muted?: MutedFlag | any;
       vip?: VipFlag | any;
       wellknown?: WellknownFlag | any;
@@ -6354,6 +6385,8 @@ declare namespace Paths {
     export type RequestBody = Components.Schemas.RenameMailboxInput;
     namespace Responses {
       export type $200 = void;
+      export type $400 = void;
+      export type $409 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -7279,7 +7312,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetMailbox.Responses.$200>;
   /**
-   * renameMailbox
+   * renameMailbox - Rename a folder, or dismiss a folder mutation that failed. `fullPath` records the rename target over the folder and everything under it; the folder keeps the path the mail server holds until the rename lands. A `fullPath` equal to the folder's current one is a dismissal: it clears a failed rename or delete and enqueues nothing. Refused with 400 for INBOX at either end, a name reserved for a system folder, and a name another folder already has; with 409 when a mutation is already in flight on the folder or on anything inside it.
    */
   'renameMailbox'(
     parameters?: Parameters<Paths.RenameMailbox.PathParameters> | null,
@@ -8065,7 +8098,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.GetMailbox.Responses.$200>;
     /**
-     * renameMailbox
+     * renameMailbox - Rename a folder, or dismiss a folder mutation that failed. `fullPath` records the rename target over the folder and everything under it; the folder keeps the path the mail server holds until the rename lands. A `fullPath` equal to the folder's current one is a dismissal: it clears a failed rename or delete and enqueues nothing. Refused with 400 for INBOX at either end, a name reserved for a system folder, and a name another folder already has; with 409 when a mutation is already in flight on the folder or on anything inside it.
      */
     'patch'(
       parameters?: Parameters<Paths.RenameMailbox.PathParameters> | null,
@@ -8944,6 +8977,7 @@ export type Address = Components.Schemas.Address;
 export type AddressFlags = Components.Schemas.AddressFlags;
 export type TrustedFlag = Components.Schemas.TrustedFlag;
 export type BlockedFlag = Components.Schemas.BlockedFlag;
+export type NeverSpamFlag = Components.Schemas.NeverSpamFlag;
 export type VipFlag = Components.Schemas.VipFlag;
 export type WellknownFlag = Components.Schemas.WellknownFlag;
 export type JunkOnlyFlag = Components.Schemas.JunkOnlyFlag;
@@ -9076,6 +9110,7 @@ export type MessageKeywordFlag = Components.Schemas.MessageKeywordFlag;
 export type MailboxAttribute = Components.Schemas.MailboxAttribute;
 export type StorageType = Components.Schemas.StorageType;
 export type ContentEncoding = Components.Schemas.ContentEncoding;
+export type SenderOverride = Components.Schemas.SenderOverride;
 export type AccountSettingName = Components.Schemas.AccountSettingName;
 export type ConfigImportState = Components.Schemas.ConfigImportState;
 export type ConfigImportRefKind = Components.Schemas.ConfigImportRefKind;