@remit/api-openapi-types 0.0.100 → 0.0.101

package/package.json

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

package/types.d.ts

@@ -153,6 +153,18 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * 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 at index time and in the back-apply corpus projection.
      */
     export type FilterClauseField = "From" | "Subject" | "HasWords" | "ListId" | "FromDomain";
+    /**
+     * How a FilterRule header or address test compares its key (RFC 040, after Sieve's `:is` and `:contains`). Both fold case.
+     */
+    export type FilterRuleMatch = "Is" | "Contains";
+    /**
+     * The header a FilterRule header test reads (RFC 040). `ListId` is normalized as a `List-Id` filter clause is.
+     */
+    export type FilterRuleHeader = "From" | "Subject" | "ListId";
+    /**
+     * The part of the From address a FilterRule address test reads (RFC 040). `RegistrableDomain` is the public-suffix aware domain.
+     */
+    export type FilterRuleAddressPart = "All" | "Localpart" | "Domain" | "RegistrableDomain";
     /**
      * Display color for a user-defined Label (RFC 030).
      */
@@ -2389,6 +2401,10 @@ create one (RFC 034 recap).
        * Literal from/subject/has-words predicate clauses (RFC 031). A filter carries at least one.
        */
       literalClauses: FilterClause[];
+      /**
+       * The stored rule. A version 0 row predates rules and its literalClauses are the truth. Not surfaced on the API yet.
+       */
+      rule: FilterRuleV0 | FilterRuleV1;
       /**
        * 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.
        */
@@ -2413,6 +2429,65 @@ create one (RFC 034 recap).
        */
       value: String256;
     }
+    /**
+     * A row written before rules existed: the filter's literal clauses are the truth.
+     */
+    export interface FilterRuleV0 {
+      version: 0;
+    }
+    /**
+     * A rule whose test is the truth; the row's literal clauses are empty.
+     */
+    export interface FilterRuleV1 {
+      version: 1;
+      test: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest;
+    }
+    /**
+     * Matches when every test in `tests` matches (Sieve `allof`).
+     */
+    export interface FilterAllOfTest {
+      test: "allof";
+      tests: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest[];
+    }
+    /**
+     * Matches when any test in `tests` matches (Sieve `anyof`).
+     */
+    export interface FilterAnyOfTest {
+      test: "anyof";
+      tests: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest[];
+    }
+    /**
+     * Matches when `operand` does not (Sieve `not`).
+     */
+    export interface FilterNotTest {
+      test: "not";
+      operand: FilterAllOfTest | FilterAnyOfTest | FilterNotTest | FilterHeaderTest | FilterAddressTest | FilterHasWordsTest;
+    }
+    /**
+     * Compares one header against one key (Sieve `header`).
+     */
+    export interface FilterHeaderTest {
+      test: "header";
+      match: FilterRuleMatch;
+      header: FilterRuleHeader;
+      key: String256;
+    }
+    /**
+     * Compares one part of the From address against one key (Sieve `address`). Reads `from` only.
+     */
+    export interface FilterAddressTest {
+      test: "address";
+      match: FilterRuleMatch;
+      part: FilterRuleAddressPart;
+      key: String256;
+    }
+    /**
+     * Matches when every word occurs in the sender, the subject or the body.
+     */
+    export interface FilterHasWordsTest {
+      test: "hasWords";
+      words: String256[];
+    }
     /**
      * Filter item returned by list/get/create/update operations. `ttl` is internal bookkeeping (RFC 034 Decision 1.3) and not surfaced.
      */
@@ -2793,6 +2868,10 @@ standing to persist.
        * Snapshot of the literal predicate clauses
        */
       literalClauses: FilterClause[];
+      /**
+       * Snapshot of the rule. A version 0 row predates rules and its literalClauses are the truth.
+       */
+      rule: FilterRuleV0 | FilterRuleV1;
       /**
        * Snapshot of the additive label action, or `"None"`
        */
@@ -10509,6 +10588,14 @@ export type RenameMailboxInput = Components.Schemas.RenameMailboxInput;
 export type AppointFolderRoleInput = Components.Schemas.AppointFolderRoleInput;
 export type Filter = Components.Schemas.Filter;
 export type FilterClause = Components.Schemas.FilterClause;
+export type FilterRuleV0 = Components.Schemas.FilterRuleV0;
+export type FilterRuleV1 = Components.Schemas.FilterRuleV1;
+export type FilterAllOfTest = Components.Schemas.FilterAllOfTest;
+export type FilterAnyOfTest = Components.Schemas.FilterAnyOfTest;
+export type FilterNotTest = Components.Schemas.FilterNotTest;
+export type FilterHeaderTest = Components.Schemas.FilterHeaderTest;
+export type FilterAddressTest = Components.Schemas.FilterAddressTest;
+export type FilterHasWordsTest = Components.Schemas.FilterHasWordsTest;
 export type FilterResponse = Components.Schemas.FilterResponse;
 export type CreateFilterInput = Components.Schemas.CreateFilterInput;
 export type CreateFilterResponse = Components.Schemas.CreateFilterResponse;
@@ -10697,6 +10784,9 @@ 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 FilterRuleMatch = Components.Schemas.FilterRuleMatch;
+export type FilterRuleHeader = Components.Schemas.FilterRuleHeader;
+export type FilterRuleAddressPart = Components.Schemas.FilterRuleAddressPart;
 export type LabelColor = Components.Schemas.LabelColor;
 export type OrganizeJobState = Components.Schemas.OrganizeJobState;
 export type CalendarColor = Components.Schemas.CalendarColor;