@remit/api-openapi-spec 0.0.67 → 0.0.69

package/openapi.json

@@ -2361,7 +2361,7 @@
       },
       "post": {
         "operationId": "CalendarEventOperations_createCalendarEvent",
-        "description": "Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all.",
+        "description": "Create an event. The server builds the VEVENT and writes it through the single calendar write path — the same one an accepted invitation and a later CalDAV PUT go through — so the object, its expanded occurrences and the collection's sync sequence land together or not at all. Refused with 400 `read_only_calendar` for a `Subscribed` collection, whose events belong to the feed.",
         "parameters": [],
         "responses": {
           "200": {
@@ -2620,7 +2620,7 @@
       },
       "delete": {
         "operationId": "CalendarEventDetailOperations_deleteCalendarEvent",
-        "description": "Delete an event. `All` removes the resource and every occurrence it\nproduced; `This` writes an EXDATE for the named occurrence and keeps the\nrest of the series; `Following` truncates the series to end just before\nit.\n\nSame refusals and the same `If-Match` precondition as the update.",
+        "description": "Delete an event. `All` removes the resource and every occurrence it\nproduced; `This` writes an EXDATE for the named occurrence and keeps the\nrest of the series; `Following` truncates the series to end just before\nit.\n\nSame refusals and the same `If-Match` precondition as the update.\nAn event in a `Subscribed` collection is refused with 400\n`read_only_calendar`, here and on the update.",
         "parameters": [
           {
             "name": "calendarObjectId",
@@ -3126,7 +3126,7 @@
       },
       "post": {
         "operationId": "CalendarOperations_createCalendar",
-        "description": "Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists.",
+        "description": "Create a calendar collection. Refused with 400 when `urlSegment` is empty or already taken in this account config — the segment is the collection's identity, so a second create under the same one would otherwise silently return the collection that already exists. With `subscriptionUrl` the feed is fetched first and a fetch that fails is refused with 400 `subscription_unreachable`, naming why and never the URL.",
         "parameters": [],
         "responses": {
           "200": {
@@ -3236,6 +3236,7 @@
       },
       "patch": {
         "operationId": "CalendarDetailOperations_updateCalendar",
+        "description": "Update a calendar collection. `subscriptionEnabled` is refused with 400 `not_subscribed` on a collection that is not `Subscribed`. Turning it off stops the refresh and removes nothing.",
         "parameters": [
           {
             "name": "calendarId",
@@ -7693,6 +7694,11 @@
           "source",
           "timezone",
           "syncSequence",
+          "subscriptionUrl",
+          "subscriptionEnabled",
+          "subscriptionCheckedAt",
+          "subscriptionFetchedAt",
+          "subscriptionError",
           "createdAt",
           "updatedAt"
         ],
@@ -7777,6 +7783,45 @@
             "default": 0,
             "readOnly": true
           },
+          "subscriptionUrl": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String2048"
+              }
+            ],
+            "description": "The read-only iCalendar URL a `Subscribed` collection is filled from, such as a Google Calendar secret address. For some providers the URL is the whole credential, so it never reaches a log line. `\"\"` for every other source.",
+            "default": "",
+            "readOnly": true
+          },
+          "subscriptionEnabled": {
+            "type": "boolean",
+            "description": "Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.",
+            "default": false
+          },
+          "subscriptionCheckedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "When the subscription was last fetched, whatever the outcome. `0` when it never was.",
+            "default": 0,
+            "readOnly": true
+          },
+          "subscriptionFetchedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "When the subscription was last fetched and written. `0` when it never was.",
+            "default": 0,
+            "readOnly": true
+          },
+          "subscriptionError": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String512"
+              }
+            ],
+            "description": "Why the last fetch failed, or which events in it could not be stored. `\"\"` when the last fetch landed whole.",
+            "default": "",
+            "readOnly": true
+          },
           "createdAt": {
             "type": "integer",
             "format": "int64",
@@ -7795,9 +7840,10 @@
         "enum": [
           "Default",
           "UserCreated",
-          "MailDerived"
+          "MailDerived",
+          "Subscribed"
         ],
-        "description": "Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person."
+        "description": "Where a calendar collection came from. `Default` is the one provisioned per account config on first use and is never deleted; `UserCreated` is one a person made; `MailDerived` is one populated from mail rather than by a person; `Subscribed` is filled from a read-only iCalendar URL and refuses every write except its own refresh."
       },
       "RemitImap.CalendarSuggestionResponse": {
         "type": "object",
@@ -8141,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"
@@ -8505,6 +8551,14 @@
               }
             ],
             "description": "IANA time zone this collection's floating times are read in. Absent reads them as UTC."
+          },
+          "subscriptionUrl": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String2048"
+              }
+            ],
+            "description": "A read-only iCalendar URL to subscribe the collection to. `http`, `https` and `webcal` are accepted. The server fetches it once before creating anything and refuses with 400 when the fetch fails, so a mistyped address leaves no empty calendar behind. The collection is then `Subscribed`: it refuses event writes, and the scheduled refresh keeps it in step with the feed."
           }
         },
         "description": "Input for creating a calendar collection (issue #15).\n\n`urlSegment` is supplied rather than derived from the display name: it is the\ncollection's identity — `calendarId` is a hash of it — and the path a CalDAV\nclient will later bookmark. Slugging a name would make two calendars called\n\"Work\" one row, and a rename would either move a bookmarked path or leave a\nsegment that no longer matches anything a person recognises. The name is the\nmutable overlay; this is the address."
@@ -9075,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": [
@@ -9091,6 +9156,7 @@
           "name",
           "scope",
           "state",
+          "disabledReason",
           "hasAnchor",
           "ruleChangedAt",
           "actionChangedAt",
@@ -9146,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": {
@@ -9220,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",
@@ -12159,9 +12235,14 @@
             ],
             "description": "IANA time zone this collection's floating times are read in, e.g. \"Europe/Amsterdam\". `\"\"` when none is set, which reads as UTC.",
             "default": ""
+          },
+          "subscriptionEnabled": {
+            "type": "boolean",
+            "description": "Whether the scheduled refresh re-reads `subscriptionUrl`. Turning it off stops the refresh and keeps every stored event. Always `false` on a collection that is not `Subscribed`.",
+            "default": false
           }
         },
-        "description": "Input for updating a calendar collection. The name, colour and timezone are the mutable overlay; `urlSegment` is not among them, because it is the collection's identity and the path a client has bookmarked."
+        "description": "Input for updating a calendar collection. The name, colour and timezone are the mutable overlay, and `subscriptionEnabled` turns a subscribed collection's refresh off and on. `urlSegment` is not among them, because it is the collection's identity and the path a client has bookmarked."
       },
       "RemitImap.UpdateFilterInput": {
         "type": "object",
@@ -12186,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": [
               {
@@ -12214,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.67",
+  "version": "0.0.69",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",