@remit/api-openapi-spec 0.0.68 → 0.0.69

package/openapi.json

@@ -8187,7 +8187,7 @@
           },
           "reason": {
             "type": "string",
-            "description": "Why, when the verdict is skipped or rejected"
+            "description": "Why, when the verdict is skipped or rejected; for a filter that lands switched off, what it is waiting for"
           }
         },
         "description": "What became of one item in the submitted document"
@@ -9129,6 +9129,17 @@
         ],
         "description": "Message attribute a FilterClause matches against — RFC 031's Tier 0 literal predicates plus the RFC 038 D2 additions (list membership and sender domain). Every member is matched vector-free at index time and in the back-apply corpus projection."
       },
+      "RemitImap.FilterDisabledReason": {
+        "type": "string",
+        "enum": [
+          "None",
+          "UserDisabled",
+          "AwaitingFolder",
+          "FolderCreateFailed",
+          "FolderMissing"
+        ],
+        "description": "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."
+      },
       "RemitImap.FilterMatchOperator": {
         "type": "string",
         "enum": [
@@ -9145,6 +9156,7 @@
           "name",
           "scope",
           "state",
+          "disabledReason",
           "hasAnchor",
           "ruleChangedAt",
           "actionChangedAt",
@@ -9200,8 +9212,17 @@
                 "$ref": "#/components/schemas/RemitImap.FilterState"
               }
             ],
-            "description": "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.",
-            "default": "Active",
+            "description": "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.",
+            "default": "Active"
+          },
+          "disabledReason": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterDisabledReason"
+              }
+            ],
+            "description": "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.",
+            "default": "None",
             "readOnly": true
           },
           "hasAnchor": {
@@ -9274,9 +9295,10 @@
         "type": "string",
         "enum": [
           "Active",
-          "Expired"
+          "Expired",
+          "Disabled"
         ],
-        "description": "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."
+        "description": "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."
       },
       "RemitImap.FolderAppointment": {
         "type": "object",
@@ -12245,6 +12267,15 @@
             "type": "string",
             "description": "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."
           },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterState"
+              }
+            ],
+            "description": "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.",
+            "default": "Active"
+          },
           "matchOperator": {
             "allOf": [
               {
@@ -12273,7 +12304,7 @@
             "default": "None"
           }
         },
-        "description": "Input for updating a filter (RFC 034, reader #266). The name, predicate,\naction, scope, and expiresAt are all updatable; `ttl` is always\nserver-derived from `scope`/`expiresAt`, never client-supplied, and\n`state`/`hasAnchor`/`ruleChangedAt`/`actionChangedAt`/`filterId` are\nserver-derived too. A patch touching the predicate, the action, `scope`, or\n`expiresAt` bumps `ruleChangedAt`; a name-only rename never does (RFC 034\nDecision 3.2, reader #266). Only a patch touching the predicate or the\naction bumps `actionChangedAt`, the narrower signal exclusive-move\nprecedence reads (reader #384) — a scope/expiresAt-only edit leaves it\nuntouched.\n\nThe semantic anchor has no field here at all — it is set once, from\n`anchorMessageId`, only on `CreateFilterInput`. Repointing an anchor would\nsilently change what a saved filter matches with nothing visible changing;\nthat deserves a new filter, so the server rejects any attempt to smuggle an\nanchor change through this body (reader #266)."
+        "description": "Input for updating a filter (RFC 034, reader #266). The name, predicate,\naction, scope, and expiresAt are all updatable; `ttl` is always\nserver-derived from `scope`/`expiresAt`, never client-supplied, and\n`disabledReason`/`hasAnchor`/`ruleChangedAt`/`actionChangedAt`/`filterId` are\nserver-derived too. `state` takes `Active` or `Disabled`: the user turns a\nfilter off or back on, and turning it on clears `disabledReason`. `Expired`\nis refused; the expiry is set through `scope`/`expiresAt`. A patch touching the predicate, the action, `scope`, or\n`expiresAt` bumps `ruleChangedAt`; a name-only rename never does (RFC 034\nDecision 3.2, reader #266). Only a patch touching the predicate or the\naction bumps `actionChangedAt`, the narrower signal exclusive-move\nprecedence reads (reader #384) — a scope/expiresAt-only edit leaves it\nuntouched.\n\nThe semantic anchor has no field here at all — it is set once, from\n`anchorMessageId`, only on `CreateFilterInput`. Repointing an anchor would\nsilently change what a saved filter matches with nothing visible changing;\nthat deserves a new filter, so the server rejects any attempt to smuggle an\nanchor change through this body (reader #266)."
       },
       "RemitImap.UpdateFlagsInput": {
         "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.68",
+  "version": "0.0.69",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",