@remit/api-openapi-types 0.0.71 → 0.0.72

package/package.json

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

package/types.d.ts

@@ -122,9 +122,13 @@ current enum emitter anyway, so the wire contract uses the bare form.
      */
     export type FilterScope = "Standing" | "Temporary";
     /**
-     * Cache of whether a Filter is still active to evaluate, backing the byAccountAndState index (RFC 034 Decision 1.2). Not the source of truth for expiry — Filter.expiresAt is, compared directly at every evaluation. Starts Active; lazily patched to Expired the first time something reads a Temporary filter past its expiresAt. No Disabled value: this RFC has no flow that pauses a filter without deleting it.
+     * Whether a Filter runs, backing the byAccountAndState index (RFC 034 Decision 1.2). Active and Disabled are written; Expired is a lazily-patched cache of Filter.expiresAt, which stays the source of truth for expiry. A Disabled filter records why in Filter.disabledReason.
      */
-    export type FilterState = "Active" | "Expired";
+    export type FilterState = "Active" | "Expired" | "Disabled";
+    /**
+     * Why a Filter is Disabled. `None` while the filter is not Disabled; every other value names the one thing that has to change before it can run again.
+     */
+    export type FilterDisabledReason = "None" | "UserDisabled" | "AwaitingFolder" | "FolderCreateFailed" | "FolderMissing";
     /**
      * How a Filter's literalClauses combine (RFC 031 "literal predicates, AND/OR"). Ignored when literalClauses is empty.
      */
@@ -1639,7 +1643,7 @@ finds it.
        */
       verdict: string;
       /**
-       * Why, when the verdict is skipped or rejected
+       * Why, when the verdict is skipped or rejected; for a filter that lands switched off, what it is waiting for
        */
       reason?: string;
     }
@@ -2031,9 +2035,13 @@ data through `byAccountAndState`.
        */
       ttl?: number;
       /**
-       * Cache of whether this filter is still active, backing byAccountAndState (RFC 034 Decision 1.2). Starts Active; lazily patched to Expired the first time something reads a Temporary filter past its expiresAt — whichever of index-time evaluation, retroactive replay, or a settings-page list touches it next. Never the correctness source; expiresAt is.
+       * Whether this filter runs, backing byAccountAndState (RFC 034 Decision 1.2). Starts Active. The user sets Active or Disabled on update; the system sets Disabled when the filter cannot work as designed, and records why in disabledReason. Expired is lazily patched the first time something reads a Temporary filter past its expiresAt, which stays the correctness source for expiry.
        */
       state: FilterState;
+      /**
+       * Why this filter is Disabled; `None` whenever state is not Disabled. Written together with state, never on its own: turning a filter on clears it.
+       */
+      disabledReason: FilterDisabledReason;
       /**
        * Whether a sibling FilterAnchor row exists for this filter (RFC 034 Decision 2.3). Lets the index-time worker skip the FilterAnchor `get` entirely for purely-literal filters instead of probing for a row that may not exist.
        */
@@ -2103,9 +2111,13 @@ data through `byAccountAndState`.
        */
       expiresAt?: string;
       /**
-       * Cache of whether this filter is still active, backing byAccountAndState (RFC 034 Decision 1.2). Starts Active; lazily patched to Expired the first time something reads a Temporary filter past its expiresAt — whichever of index-time evaluation, retroactive replay, or a settings-page list touches it next. Never the correctness source; expiresAt is.
+       * Whether this filter runs, backing byAccountAndState (RFC 034 Decision 1.2). Starts Active. The user sets Active or Disabled on update; the system sets Disabled when the filter cannot work as designed, and records why in disabledReason. Expired is lazily patched the first time something reads a Temporary filter past its expiresAt, which stays the correctness source for expiry.
        */
       state: FilterState;
+      /**
+       * Why this filter is Disabled; `None` whenever state is not Disabled. Written together with state, never on its own: turning a filter on clears it.
+       */
+      disabledReason: FilterDisabledReason;
       /**
        * Whether a sibling FilterAnchor row exists for this filter (RFC 034 Decision 2.3). Lets the index-time worker skip the FilterAnchor `get` entirely for purely-literal filters instead of probing for a row that may not exist.
        */
@@ -2185,8 +2197,10 @@ sets `hasAnchor`. Absent for a purely-literal filter.
      * Input for updating a filter (RFC 034, reader #266). The name, predicate,
 action, scope, and expiresAt are all updatable; `ttl` is always
 server-derived from `scope`/`expiresAt`, never client-supplied, and
-`state`/`hasAnchor`/`ruleChangedAt`/`actionChangedAt`/`filterId` are
-server-derived too. A patch touching the predicate, the action, `scope`, or
+`disabledReason`/`hasAnchor`/`ruleChangedAt`/`actionChangedAt`/`filterId` are
+server-derived too. `state` takes `Active` or `Disabled`: the user turns a
+filter off or back on, and turning it on clears `disabledReason`. `Expired`
+is refused; the expiry is set through `scope`/`expiresAt`. A patch touching the predicate, the action, `scope`, or
 `expiresAt` bumps `ruleChangedAt`; a name-only rename never does (RFC 034
 Decision 3.2, reader #266). Only a patch touching the predicate or the
 action bumps `actionChangedAt`, the narrower signal exclusive-move
@@ -2212,6 +2226,10 @@ anchor change through this body (reader #266).
        * ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence. Mutable on update (reader #266), alongside scope — moving the date bumps ruleChangedAt the same way a scope change does.
        */
       expiresAt?: string;
+      /**
+       * Whether this filter runs, backing byAccountAndState (RFC 034 Decision 1.2). Starts Active. The user sets Active or Disabled on update; the system sets Disabled when the filter cannot work as designed, and records why in disabledReason. Expired is lazily patched the first time something reads a Temporary filter past its expiresAt, which stays the correctness source for expiry.
+       */
+      state: FilterState;
       /**
        * How literalClauses combine. Meaningless when literalClauses is empty.
        */
@@ -5613,6 +5631,10 @@ the binder writes the row it belongs to once the path resolves.
        * The role for a folder role, the folder path for a mailbox override, the filter id for a filter's move action
        */
       target: String256;
+      /**
+       * The folder the binder asked the mail server to create for this path, once discovery showed the account lacks it. The binder waits for that row to settle and binds to it by id, because the server may store the folder under a normalized path. `None` until a create is issued.
+       */
+      mailboxId: string;
     }
     /**
      * One applied configuration import (#1021). It exists because a file's folder
@@ -9194,6 +9216,7 @@ export type MailboxCursorState = Components.Schemas.MailboxCursorState;
 export type MailboxSpecialUse = Components.Schemas.MailboxSpecialUse;
 export type FilterScope = Components.Schemas.FilterScope;
 export type FilterState = Components.Schemas.FilterState;
+export type FilterDisabledReason = Components.Schemas.FilterDisabledReason;
 export type FilterMatchOperator = Components.Schemas.FilterMatchOperator;
 export type FilterClauseField = Components.Schemas.FilterClauseField;
 export type LabelColor = Components.Schemas.LabelColor;