@remit/api-openapi-types 0.0.70 → 0.0.72

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.70",
+  "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.
      */
@@ -150,9 +154,9 @@ current enum emitter anyway, so the wire contract uses the bare form.
      */
     export type CalendarComponentSet = "VeventOnly";
     /**
-     * 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.
+     * 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.
      */
-    export type CalendarSource = "Default" | "UserCreated" | "MailDerived";
+    export type CalendarSource = "Default" | "UserCreated" | "MailDerived" | "Subscribed";
     /**
      * Projection of a VEVENT's STATUS property (RFC 5545 3.8.1.11). A VEVENT with no STATUS projects as `Confirmed`, which is the value RFC 5545 gives an event whose status is unstated.
      */
@@ -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.
        */
@@ -2583,6 +2601,26 @@ and what `CalendarObject.bySyncSequence` pages by.
        * Monotonic change counter for this collection. Bumped by every write to one of its objects; the value stamped on `CalendarObject.syncSequence` is the value this counter held after that write.
        */
       syncSequence: number;
+      /**
+       * 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.
+       */
+      subscriptionUrl: String2048;
+      /**
+       * 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`.
+       */
+      subscriptionEnabled: boolean;
+      /**
+       * When the subscription was last fetched, whatever the outcome. `0` when it never was.
+       */
+      subscriptionCheckedAt: number;
+      /**
+       * When the subscription was last fetched and written. `0` when it never was.
+       */
+      subscriptionFetchedAt: number;
+      /**
+       * Why the last fetch failed, or which events in it could not be stored. `""` when the last fetch landed whole.
+       */
+      subscriptionError: String512;
       createdAt: number;
       updatedAt: number;
     }
@@ -2626,6 +2664,26 @@ and what `CalendarObject.bySyncSequence` pages by.
        * Monotonic change counter for this collection. Bumped by every write to one of its objects; the value stamped on `CalendarObject.syncSequence` is the value this counter held after that write.
        */
       syncSequence: number;
+      /**
+       * 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.
+       */
+      subscriptionUrl: String2048;
+      /**
+       * 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`.
+       */
+      subscriptionEnabled: boolean;
+      /**
+       * When the subscription was last fetched, whatever the outcome. `0` when it never was.
+       */
+      subscriptionCheckedAt: number;
+      /**
+       * When the subscription was last fetched and written. `0` when it never was.
+       */
+      subscriptionFetchedAt: number;
+      /**
+       * Why the last fetch failed, or which events in it could not be stored. `""` when the last fetch landed whole.
+       */
+      subscriptionError: String512;
       createdAt: number;
       updatedAt: number;
     }
@@ -2656,9 +2714,13 @@ mutable overlay; this is the address.
        * IANA time zone this collection's floating times are read in. Absent reads them as UTC.
        */
       timezone?: String64;
+      /**
+       * 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.
+       */
+      subscriptionUrl?: String2048;
     }
     /**
-     * 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.
+     * 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.
      */
     export interface UpdateCalendarInput {
       /**
@@ -2673,6 +2735,10 @@ mutable overlay; this is the address.
        * IANA time zone this collection's floating times are read in, e.g. "Europe/Amsterdam". `""` when none is set, which reads as UTC.
        */
       timezone: String64;
+      /**
+       * 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`.
+       */
+      subscriptionEnabled: boolean;
     }
     /**
      * Nothing to return. The resource, or the occurrence, is gone.
@@ -5565,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
@@ -7522,7 +7592,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ListCalendars.Responses.$200>;
   /**
-   * createCalendar - 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.
+   * createCalendar - 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.
    */
   'createCalendar'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -7538,7 +7608,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetCalendar.Responses.$200>;
   /**
-   * updateCalendar
+   * updateCalendar - 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.
    */
   'updateCalendar'(
     parameters?: Parameters<Paths.UpdateCalendar.PathParameters> | null,
@@ -7622,7 +7692,7 @@ Refused with 400 when `from` and `to` are not ISO 8601 date-times, when
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ListCalendarEvents.Responses.$200>;
   /**
-   * createCalendarEvent - 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.
+   * createCalendarEvent - 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.
    */
   'createCalendarEvent'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -7664,6 +7734,8 @@ rest of the series; `Following` truncates the series to end just before
 it.
 
 Same refusals and the same `If-Match` precondition as the update.
+An event in a `Subscribed` collection is refused with 400
+`read_only_calendar`, here and on the update.
    */
   'deleteCalendarEvent'(
     parameters?: Parameters<Paths.DeleteCalendarEvent.PathParameters & Paths.DeleteCalendarEvent.QueryParameters & Paths.DeleteCalendarEvent.HeaderParameters> | null,
@@ -8326,7 +8398,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ListCalendars.Responses.$200>;
     /**
-     * createCalendar - 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.
+     * createCalendar - 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.
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -8344,7 +8416,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.GetCalendar.Responses.$200>;
     /**
-     * updateCalendar
+     * updateCalendar - 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.
      */
     'patch'(
       parameters?: Parameters<Paths.UpdateCalendar.PathParameters> | null,
@@ -8434,7 +8506,7 @@ Refused with 400 when `from` and `to` are not ISO 8601 date-times, when
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ListCalendarEvents.Responses.$200>;
     /**
-     * createCalendarEvent - 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.
+     * createCalendarEvent - 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.
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -8478,6 +8550,8 @@ rest of the series; `Following` truncates the series to end just before
 it.
 
 Same refusals and the same `If-Match` precondition as the update.
+An event in a `Subscribed` collection is refused with 400
+`read_only_calendar`, here and on the update.
      */
     'delete'(
       parameters?: Parameters<Paths.DeleteCalendarEvent.PathParameters & Paths.DeleteCalendarEvent.QueryParameters> | null,
@@ -9142,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;