@remit/api-openapi-spec 0.0.68 → 0.0.70

package/openapi.json

@@ -2873,7 +2873,7 @@
     "/calendar-suggestions/{suggestionId}/accept": {
       "post": {
         "operationId": "CalendarSuggestionActionOperations_acceptCalendarSuggestion",
-        "description": "Add the suggested event to a calendar. One transaction: a VCALENDAR is\nbuilt from the invitation's own bytes, keeping its UID and SEQUENCE and\nmarking the user `ATTENDEE;PARTSTAT=ACCEPTED`, and written through the\nsame service function every other calendar write goes through — so a web\nedit and a native edit of that event cannot diverge. Accepting a `Cancel`\nsuggestion writes `STATUS:CANCELLED` on the resource the same way.\n\nNo reply is sent to the organizer. This endpoint sends no mail at all,\nand the card says so.\n\nIdempotent: accepting an already-accepted suggestion rewrites the same\nresource and returns the same suggestion, because both the resource id\nand the suggestion id are derived rather than minted.\n\n400 when the suggestion is not one that can be accepted — already\ndeclined, dismissed or superseded — or when its iCalendar will not parse.",
+        "description": "Add the suggested event to a calendar. One transaction: a VCALENDAR is\nbuilt from the invitation's own bytes, keeping its UID and SEQUENCE and\nmarking the user `ATTENDEE;PARTSTAT=ACCEPTED`, and written through the\nsame service function every other calendar write goes through — so a web\nedit and a native edit of that event cannot diverge. Accepting a `Cancel`\nsuggestion writes `STATUS:CANCELLED` on the resource the same way.\n\n`answer: Tentative` writes the same resource with `PARTSTAT=TENTATIVE`\nand moves the suggestion to `Tentative` instead of `Accepted`.\n\nNo reply is sent to the organizer. This endpoint sends no mail at all,\nand the card says so.\n\nIdempotent: accepting an already-accepted suggestion rewrites the same\nresource and returns the same suggestion, because both the resource id\nand the suggestion id are derived rather than minted.\n\n400 when the suggestion is not one that can be accepted — already\nanswered otherwise, dismissed or superseded — when a `Cancel` suggestion\nis answered `Tentative`, or when its iCalendar will not parse.",
         "parameters": [
           {
             "name": "suggestionId",
@@ -6236,6 +6236,15 @@
               }
             ],
             "description": "Collection the accepted event is written into."
+          },
+          "answer": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.CalendarInviteAnswer"
+              }
+            ],
+            "description": "How the user answers. `Tentative` adds the event as a maybe. Refused with 400 on a `Cancel` suggestion, which has nothing to answer tentatively.",
+            "default": "Accepted"
           }
         },
         "description": "Body of `POST /calendar-suggestions/{suggestionId}/accept`. Names the collection the event is written into; there is no default, because filing someone else's invitation into a calendar the user did not pick is a decision the server does not get to make."
@@ -7655,6 +7664,14 @@
         },
         "description": "One stretch of time the caller is busy in. Merged across every calendar they\nhold, so two overlapping meetings in two calendars are one span and a caller\nasking \"is this slot free\" never has to do the merging itself."
       },
+      "RemitImap.CalendarInviteAnswer": {
+        "type": "string",
+        "enum": [
+          "Accepted",
+          "Tentative"
+        ],
+        "description": "The answer an invitation is added to a calendar with. It is written as the user's `ATTENDEE;PARTSTAT` on the stored event (RFC 5545 3.2.12) and becomes the suggestion's state."
+      },
       "RemitImap.CalendarInviteMethod": {
         "type": "string",
         "enum": [
@@ -8016,7 +8033,7 @@
           },
           "acceptedCalendarObjectId": {
             "type": "string",
-            "description": "The `CalendarObject` that accepting this suggestion wrote. `\"\"` until it is accepted — the named absent state, never a missing attribute — and the resource's id afterwards, so the card can link to the event it produced.",
+            "description": "The `CalendarObject` that accepting this suggestion wrote. `\"\"` until it is accepted or answered tentatively — the named absent state, never a missing attribute — and the resource's id afterwards, so the card can link to the event it produced.",
             "default": "",
             "readOnly": true
           },
@@ -8187,7 +8204,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 +9146,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 +9173,7 @@
           "name",
           "scope",
           "state",
+          "disabledReason",
           "hasAnchor",
           "ruleChangedAt",
           "actionChangedAt",
@@ -9200,8 +9229,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 +9312,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 +12284,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 +12321,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.70",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",