@remit/api-openapi-types 0.0.76 → 0.0.78

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.76",
+  "version": "0.0.78",
   "type": "module",
   "main": "types.d.ts",
   "types": "types.d.ts",

package/types.d.ts

@@ -304,6 +304,10 @@ distinguishable from a network failure without parsing prose.
      * Where in a message a suggestion was read from. It is what a card says to explain itself, and it is what separates a suggestion carrying real iCalendar from one inferred out of prose.
      */
     export type CalendarSuggestionSource = "IcalendarPart" | "IcalendarAttachment" | "TextHeuristic";
+    /**
+     * Whether an answered cancellation holds the calendar object this suggestion's answer wrote. A cancellation is terminal, so such an answer cannot be taken back.
+     */
+    export type CalendarAnswerOvertaken = "None" | "Cancellation";
     /**
      * 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.
      */
@@ -2197,6 +2201,73 @@ sets `hasAnchor`. Absent for a purely-literal filter.
        */
       anchorMessageId?: UUID;
     }
+    /**
+     * Response body for POST /accounts/{accountId}/filters: the created filter, plus the back-apply job that runs it over the inbox.
+     */
+    export interface CreateFilterResponse {
+      /**
+       * Primary identifier. Stable id — the human name is a separate mutable overlay, never the key.
+       */
+      filterId: UUID;
+      /**
+       * Owning account configuration
+       */
+      accountConfigId: UUID;
+      /**
+       * Plain-language name or editable label for this filter
+       */
+      name: String256;
+      /**
+       * 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.
+       */
+      scope: FilterScope;
+      /**
+       * 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;
+      /**
+       * 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.
+       */
+      hasAnchor: boolean;
+      /**
+       * 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.
+       */
+      ruleChangedAt: number;
+      /**
+       * 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.
+       */
+      actionChangedAt: number;
+      /**
+       * How literalClauses combine. Meaningless when literalClauses is empty.
+       */
+      matchOperator: FilterMatchOperator;
+      /**
+       * Literal from/subject/has-words predicate clauses (RFC 031). Empty when the filter relies solely on its semantic anchor (see hasAnchor).
+       */
+      literalClauses: FilterClause[];
+      /**
+       * 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.
+       */
+      actionLabelId: string;
+      /**
+       * 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.
+       */
+      actionMailboxId: string;
+      createdAt: number;
+      updatedAt: number;
+      /**
+       * 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.
+       */
+      organizeJobId: string;
+    }
     /**
      * Input for updating a filter (RFC 034, reader #266). The name, predicate,
 action, scope, and expiresAt are all updatable; `ttl` is always
@@ -2339,6 +2410,10 @@ rule. The anchor is derived transiently from `anchorMessageId`'s existing chunk
 vectors at match time and never persisted as a FilterAnchor row.
      */
     export interface OrganizeInput {
+      /**
+       * 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.
+       */
+      filterId?: UUID;
       /**
        * Anchor message for the semantic half — "all like this one". Absent for a purely-literal back-apply. The anchor vector is pooled transiently from this message's indexed chunk vectors and never written to a FilterAnchor row.
        */
@@ -2426,6 +2501,10 @@ standing to persist.
        * Current lifecycle state of the job
        */
       state: OrganizeJobState;
+      /**
+       * 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).
+       */
+      filterId: string;
       /**
        * 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).
        */
@@ -2499,6 +2578,10 @@ standing to persist.
        * Current lifecycle state of the job
        */
       state: OrganizeJobState;
+      /**
+       * 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).
+       */
+      filterId: string;
       /**
        * 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).
        */
@@ -5581,6 +5664,10 @@ and no message may make that change without them.
        * The conversation holding `supersededByMessageId`, which is what the reading pane opens. `""` when this revision was not superseded, or when that message sits in no conversation any more.
        */
       supersededByThreadId: string;
+      /**
+       * Whether an answered cancellation holds the event this answer wrote. `Cancellation` means `reopen` answers 400.
+       */
+      answerOvertakenBy: CalendarAnswerOvertaken;
     }
     /**
      * 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.
@@ -7384,6 +7471,17 @@ declare namespace Paths {
       export type $401 = void;
     }
   }
+  namespace ReopenCalendarSuggestion {
+    export interface PathParameters {
+      suggestionId: Components.Schemas.UUID;
+    }
+    namespace Responses {
+      export type $200 = void;
+      export type $400 = void;
+      export type $404 = void;
+      export type $401 = void;
+    }
+  }
 }
 
 export interface OperationMethods {
@@ -8155,6 +8253,29 @@ is answered `Tentative`, or when its iCalendar will not parse.
     data?: Paths.DismissCalendarSuggestion.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.DismissCalendarSuggestion.Responses.$200>;
+  /**
+   * reopenCalendarSuggestion - Take an answer back. An accepted, tentative, declined or dismissed
+suggestion returns to `Pending`, so the card asks again. One
+transaction: the suggestion is settled `Pending` with
+`acceptedCalendarObjectId: ""`, and the calendar object an accept or a
+maybe wrote is removed with its occurrences and every remainder a
+this-and-following edit split off it in that calendar, unless another
+suggestion is still answered into that object; then the object stays with
+that answer. A sender rule written by
+`dismiss{muteSender}` stays; it is a rule of its own, edited where rules
+are.
+
+No mail is sent. Idempotent: a `Pending` suggestion is returned as it is.
+
+400 when the suggestion is `Superseded`, which a later revision retired,
+a `Cancel`, whose answer rewrote an event it cannot restore, or its
+`answerOvertakenBy` is `Cancellation`, because a cancellation is terminal.
+   */
+  'reopenCalendarSuggestion'(
+    parameters?: Parameters<Paths.ReopenCalendarSuggestion.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.ReopenCalendarSuggestion.Responses.$200>;
 }
 
 export interface PathsDictionary {
@@ -9048,6 +9169,31 @@ is answered `Tentative`, or when its iCalendar will not parse.
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.DismissCalendarSuggestion.Responses.$200>;
   };
+  ['/calendar-suggestions/{suggestionId}/reopen']: {
+    /**
+     * reopenCalendarSuggestion - Take an answer back. An accepted, tentative, declined or dismissed
+suggestion returns to `Pending`, so the card asks again. One
+transaction: the suggestion is settled `Pending` with
+`acceptedCalendarObjectId: ""`, and the calendar object an accept or a
+maybe wrote is removed with its occurrences and every remainder a
+this-and-following edit split off it in that calendar, unless another
+suggestion is still answered into that object; then the object stays with
+that answer. A sender rule written by
+`dismiss{muteSender}` stays; it is a rule of its own, edited where rules
+are.
+
+No mail is sent. Idempotent: a `Pending` suggestion is returned as it is.
+
+400 when the suggestion is `Superseded`, which a later revision retired,
+a `Cancel`, whose answer rewrote an event it cannot restore, or its
+`answerOvertakenBy` is `Cancellation`, because a cancellation is terminal.
+     */
+    'post'(
+      parameters?: Parameters<Paths.ReopenCalendarSuggestion.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.ReopenCalendarSuggestion.Responses.$200>;
+  };
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>;
@@ -9110,6 +9256,7 @@ export type Filter = Components.Schemas.Filter;
 export type FilterClause = Components.Schemas.FilterClause;
 export type FilterResponse = Components.Schemas.FilterResponse;
 export type CreateFilterInput = Components.Schemas.CreateFilterInput;
+export type CreateFilterResponse = Components.Schemas.CreateFilterResponse;
 export type UpdateFilterInput = Components.Schemas.UpdateFilterInput;
 export type Label = Components.Schemas.Label;
 export type LabelResponse = Components.Schemas.LabelResponse;
@@ -9300,6 +9447,7 @@ export type LabelAction = Components.Schemas.LabelAction;
 export type CalendarSuggestionState = Components.Schemas.CalendarSuggestionState;
 export type CalendarInviteMethod = Components.Schemas.CalendarInviteMethod;
 export type CalendarSuggestionSource = Components.Schemas.CalendarSuggestionSource;
+export type CalendarAnswerOvertaken = Components.Schemas.CalendarAnswerOvertaken;
 export type CalendarInviteAnswer = Components.Schemas.CalendarInviteAnswer;
 export type MessageSystemFlag = Components.Schemas.MessageSystemFlag;
 export type MessageKeywordFlag = Components.Schemas.MessageKeywordFlag;