@remit/api-openapi-spec 0.0.74 → 0.0.75

package/openapi.json

@@ -492,7 +492,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/RemitImap.FilterResponse"
+                  "$ref": "#/components/schemas/RemitImap.CreateFilterResponse"
                 }
               }
             }
@@ -8765,6 +8765,146 @@
         },
         "description": "Input for creating a filter (RFC 034). `ttl` is omitted — it is derived\nserver-side from `expiresAt` when `scope` is `Temporary` (RFC 034 Decision\n1.3), never client-supplied. `state`, `hasAnchor`, `ruleChangedAt`, and\n`filterId` are all server-derived and excluded by their Read-only visibility.\n\nWhen `anchorMessageId` is set, the server builds and persists the filter's\nsemantic anchor from that message's indexed vectors (RFC 034 Decision 2) and\nsets `hasAnchor`. Absent for a purely-literal filter."
       },
+      "RemitImap.CreateFilterResponse": {
+        "type": "object",
+        "required": [
+          "filterId",
+          "accountConfigId",
+          "name",
+          "scope",
+          "state",
+          "disabledReason",
+          "hasAnchor",
+          "ruleChangedAt",
+          "actionChangedAt",
+          "matchOperator",
+          "literalClauses",
+          "actionLabelId",
+          "actionMailboxId",
+          "createdAt",
+          "updatedAt",
+          "organizeJobId"
+        ],
+        "properties": {
+          "filterId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Primary identifier. Stable id — the human name is a separate mutable overlay, never the key.",
+            "readOnly": true
+          },
+          "accountConfigId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Owning account configuration",
+            "readOnly": true
+          },
+          "name": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Plain-language name or editable label for this filter"
+          },
+          "scope": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterScope"
+              }
+            ],
+            "description": "Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1). Mutable on update (reader #266): switching scope re-derives ttl and re-evaluates state from expiresAt, and bumps ruleChangedAt so a lapsed filter's back-application can be offered again. The semantic anchor stays immutable regardless — repointing it would silently change what a saved filter matches with nothing visible changing, which deserves a new filter instead."
+          },
+          "expiresAt": {
+            "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"
+          },
+          "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": {
+            "type": "boolean",
+            "description": "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.",
+            "default": false,
+            "readOnly": true
+          },
+          "ruleChangedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "Epoch seconds, written whenever the predicate, the action, the scope, or the expiry changes (reader #266) — never on a cosmetic rename. This is the broad \"the user asserted something new about this rule\" signal the settings UI uses to decide whether to re-offer a lapsed filter's back-application. It is deliberately NOT the precedence signal for the exclusive move action — see actionChangedAt for that (RFC 034 Decision 3.2, reader #384). Distinct from ElectroDB's own updatedAt, which bumps on any write.",
+            "readOnly": true
+          },
+          "actionChangedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "Epoch seconds, written only when the predicate (literalClauses, hasAnchor) or the action (actionLabelId, actionMailboxId) changes — never on scope, expiresAt, or a cosmetic rename. Backs most-recently-changed-filter-wins precedence for the exclusive move action (RFC 034 Decision 3.2). Split out from ruleChangedAt (reader #384): extending a filter's expiry or flipping its scope changes its lifecycle, not what it matches or does, so it must not promote the filter to move-winner.",
+            "readOnly": true
+          },
+          "matchOperator": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterMatchOperator"
+              }
+            ],
+            "description": "How literalClauses combine. Meaningless when literalClauses is empty.",
+            "default": "And"
+          },
+          "literalClauses": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.FilterClause"
+            },
+            "description": "Literal from/subject/has-words predicate clauses (RFC 031). Empty when the filter relies solely on its semantic anchor (see hasAnchor).",
+            "default": []
+          },
+          "actionLabelId": {
+            "type": "string",
+            "description": "Label applied when this filter matches — additive action, any number of filters can independently apply their own label (RFC 034 Decision 3.1). The named sentinel `\"None\"` means no label action; never an empty/optional field.",
+            "default": "None"
+          },
+          "actionMailboxId": {
+            "type": "string",
+            "description": "Mailbox matched messages are moved into — exclusive action, since a message lives in exactly one mailbox (RFC 034 Decision 3.1). On conflict between filters, the one with the latest actionChangedAt wins. `\"None\"` means no move action.",
+            "default": "None"
+          },
+          "createdAt": {
+            "type": "integer",
+            "format": "int64",
+            "readOnly": true
+          },
+          "updatedAt": {
+            "type": "integer",
+            "format": "int64",
+            "readOnly": true
+          },
+          "organizeJobId": {
+            "type": "string",
+            "description": "The organize job queued to run the new filter over the inbox. Poll GET /accounts/{accountId}/organize/{organizeJobId}; a filter with nothing to run reports Failed with the reason."
+          }
+        },
+        "description": "Response body for POST /accounts/{accountId}/filters: the created filter, plus the back-apply job that runs it over the inbox."
+      },
       "RemitImap.CreateLabelInput": {
         "type": "object",
         "required": [
@@ -10410,6 +10550,14 @@
           "actionMailboxId"
         ],
         "properties": {
+          "filterId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Back-apply this standing filter instead of the predicate in this body. The server reads the filter's persisted predicate, action and FilterAnchor, runs the pass over the inbox, and skips a move another active filter outranks, as index time does. The predicate and action fields of this body are ignored when it is set."
+          },
           "anchorMessageId": {
             "allOf": [
               {
@@ -10460,6 +10608,7 @@
           "accountConfigId",
           "userId",
           "state",
+          "filterId",
           "anchorMessageId",
           "matchOperator",
           "literalClauses",
@@ -10507,6 +10656,12 @@
             "default": "Pending",
             "readOnly": true
           },
+          "filterId": {
+            "type": "string",
+            "description": "The standing filter this job back-applies, or the `\"None\"` sentinel for an \"all like these\" pass. A sentinel, not an optional field, so the persisted entity has no optional attributes (RFC 032).",
+            "default": "None",
+            "readOnly": true
+          },
           "anchorMessageId": {
             "type": "string",
             "description": "Snapshot of the anchor message id, or the `\"None\"` sentinel for a purely-literal back-apply. A sentinel, not an optional field, so the persisted entity has no optional attributes (RFC 032).",

package/package.json

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