@remit/api-openapi-types 0.0.100 → 0.0.102

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.100",
+  "version": "0.0.102",
   "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).
      */
@@ -236,7 +248,7 @@ current enum emitter anyway, so the wire contract uses the bare form.
     /**
      * A label a classification provider picks for a message: the junk verdicts, priority, and the message categories.
      */
-    export type ClassificationLabel = "Spam" | "Phishing" | "Priority" | "Personal" | "Newsletter" | "Marketing" | "Automated" | "Transactional" | "Social";
+    export type ClassificationLabel = "Spam" | "Phishing" | "Priority" | "Personal" | "Newsletter" | "Marketing" | "Automated" | "Transactional" | "Social" | "ColdOutreach";
     /**
      * Why a classification provider call gave no usable answer.
      */
@@ -245,6 +257,10 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * The classification provider form field a failure points at.
      */
     export type ClassificationField = "ApiKey" | "Model" | "BaseUrl";
+    /**
+     * Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized`, which covers both a message that has not been classified yet and one the classifier declined to categorize; `Message.classificationState` is what tells those apart.
+     */
+    export type MessageCategory = "uncategorized" | "personal" | "newsletter" | "marketing" | "automated" | "transactional" | "social" | "coldOutreach";
     /**
      * Sort order for list operations
      */
@@ -253,10 +269,6 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Gmail-style star colors for message/thread marking
      */
     export type StarColor = "none" | "yellow" | "orange" | "red" | "purple" | "blue" | "teal" | "green" | "yellow_bang" | "red_bang" | "purple_question" | "blue_info" | "orange_guillemet" | "green_check" | "yellow_check" | "blue_star";
-    /**
-     * Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized`, which covers both a message that has not been classified yet and one the classifier declined to categorize; `Message.classificationState` is what tells those apart.
-     */
-    export type MessageCategory = "uncategorized" | "personal" | "newsletter" | "marketing" | "automated" | "transactional" | "social";
     /**
      * Trust level for the From address, derived at read time from AddressFlags + counters.
      */
@@ -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"`
        */
@@ -3873,6 +3952,55 @@ field on this resource rather than one more operation.
        */
       fix: string;
     }
+    /**
+     * The classifier's distribution and corrections over mail that arrived on or after `since`, across every account the caller holds.
+     */
+    export interface ClassifierStats {
+      /**
+       * The start of the window, as the request gave it: an ISO 8601 date-time with zone offset.
+       */
+      since: string;
+      /**
+       * Messages that arrived on or after `since` whose body sync classified them.
+       */
+      examined: number;
+      /**
+       * Examined messages per category; a category with none is absent.
+       */
+      byCategory: ClassifierCategoryCount[];
+      /**
+       * Confident scores per label, over the examined messages; a label with none is absent.
+       */
+      byLabel: ClassifierLabelCount[];
+      corrections: ClassifierCorrections;
+    }
+    /**
+     * Examined messages in one category.
+     */
+    export interface ClassifierCategoryCount {
+      category: MessageCategory;
+      count: number;
+    }
+    /**
+     * Confident scores for one label.
+     */
+    export interface ClassifierLabelCount {
+      label: ClassificationLabel;
+      count: number;
+    }
+    /**
+     * Times the reader disagreed with the classifier since `since`.
+     */
+    export interface ClassifierCorrections {
+      /**
+       * Messages the reader reported as spam whose stored scores held no confident `Spam` or `Phishing` score.
+       */
+      spamReportedNotJunk: number;
+      /**
+       * Senders whose `Address.flags.category` override was set on or after `since`.
+       */
+      categoryOverridden: number;
+    }
     /**
      * Tasks due in the requested window, in due order. Unpaginated: the window is the bound.
      */
@@ -5710,6 +5838,10 @@ either way and cannot tell which it received.
        * Body-sync timestamp (epoch millis) the classifier's placement verdict was first decided, whether the verdict was to move the message or to leave it in place. Absent means placement has never been evaluated for this message. Guards `computePlacement` against a re-entrant body-sync pass (`fetchAndGetBody`'s `NoSuchKey` fallback, `syncBodies(..., force: true)`) re-deciding — and possibly reversing — a placement a user has since overridden by hand. `movedByRemit` remains the guard for a message that was placement-decided before this field existed.
        */
       placementDecidedAt?: number;
+      /**
+       * Every score the classification provider gave this message at body sync. Empty when the provider was not asked or gave no answer, and for every message synced before scores were stored. Persistence-only: no response model exposes it.
+       */
+      classifierScores: ClassifierScore[];
       /**
        * Recorded when the user reported this message as spam. Absent means never reported, or reported and then undone (`POST /messages/not-spam` clears it). Independent of the message's current folder — deliberately not derived from "sits in Junk", which is also true of a message Remit moved on its own.
        */
@@ -5772,6 +5904,23 @@ either way and cannot tell which it received.
        */
       decidedAt: number;
     }
+    /**
+     * One label the classification provider scored for a message, as body sync stored it.
+     */
+    export interface ClassifierScore {
+      /**
+       * The label the provider scored.
+       */
+      label: ClassificationLabel;
+      /**
+       * The provider's confidence in `label`, between 0 and 1.
+       */
+      confidence: number;
+      /**
+       * True when `confidence` reached the threshold for the provider's kind of confidence when body sync stored it: 0.7 for a calibrated provider, 0.8 for an advisory one.
+       */
+      confident: boolean;
+    }
     /**
      * Core message entity as the API carries it: the stored row plus the Message-ID header, which is stored on the message's thread row.
      */
@@ -5876,6 +6025,10 @@ either way and cannot tell which it received.
        * Body-sync timestamp (epoch millis) the classifier's placement verdict was first decided, whether the verdict was to move the message or to leave it in place. Absent means placement has never been evaluated for this message. Guards `computePlacement` against a re-entrant body-sync pass (`fetchAndGetBody`'s `NoSuchKey` fallback, `syncBodies(..., force: true)`) re-deciding — and possibly reversing — a placement a user has since overridden by hand. `movedByRemit` remains the guard for a message that was placement-decided before this field existed.
        */
       placementDecidedAt?: number;
+      /**
+       * Every score the classification provider gave this message at body sync. Empty when the provider was not asked or gave no answer, and for every message synced before scores were stored. Persistence-only: no response model exposes it.
+       */
+      classifierScores: ClassifierScore[];
       /**
        * Recorded when the user reported this message as spam. Absent means never reported, or reported and then undone (`POST /messages/not-spam` clears it). Independent of the message's current folder — deliberately not derived from "sits in Junk", which is also true of a message Remit moved on its own.
        */
@@ -7954,6 +8107,16 @@ declare namespace Paths {
       export type $401 = void;
     }
   }
+  namespace GetClassificationStats {
+    export interface QueryParameters {
+      since: string;
+    }
+    namespace Responses {
+      export type $200 = void;
+      export type $400 = void;
+      export type $401 = void;
+    }
+  }
   namespace ListCalendarTasks {
     export interface QueryParameters {
       from: string;
@@ -8957,6 +9120,14 @@ reader organizes the event, none otherwise.
     data?: Paths.TestClassificationProvider.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<any>;
+  /**
+   * getClassificationStats - Count what the classifier decided for mail that arrived on or after `since`, and how often the reader corrected it. Refused with 400 when `since` is not an ISO 8601 date-time with zone offset.
+   */
+  'getClassificationStats'(
+    parameters?: Parameters<Paths.GetClassificationStats.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.GetClassificationStats.Responses.$200>;
   /**
    * listCalendarTasks - Tasks due in a window, across every task collection the caller holds, in due order. Refused with 400 on the same window rules as the event listing.
    */
@@ -9936,6 +10107,16 @@ reader organizes the event, none otherwise.
       config?: AxiosRequestConfig
     ): OperationResponse<any>;
   };
+  ['/classification-stats']: {
+    /**
+     * getClassificationStats - Count what the classifier decided for mail that arrived on or after `since`, and how often the reader corrected it. Refused with 400 when `since` is not an ISO 8601 date-time with zone offset.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetClassificationStats.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.GetClassificationStats.Responses.$200>;
+  };
   ['/calendar-tasks']: {
     /**
      * listCalendarTasks - Tasks due in a window, across every task collection the caller holds, in due order. Refused with 400 on the same window rules as the event listing.
@@ -10509,6 +10690,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;
@@ -10560,6 +10749,10 @@ export type UpdateUserSettingsInput = Components.Schemas.UpdateUserSettingsInput
 export type ClassificationTestInput = Components.Schemas.ClassificationTestInput;
 export type ClassificationTestPassed = Components.Schemas.ClassificationTestPassed;
 export type ClassificationTestFailed = Components.Schemas.ClassificationTestFailed;
+export type ClassifierStats = Components.Schemas.ClassifierStats;
+export type ClassifierCategoryCount = Components.Schemas.ClassifierCategoryCount;
+export type ClassifierLabelCount = Components.Schemas.ClassifierLabelCount;
+export type ClassifierCorrections = Components.Schemas.ClassifierCorrections;
 export type CalendarTaskListResponse = Components.Schemas.CalendarTaskListResponse;
 export type CalendarTask = Components.Schemas.CalendarTask;
 export type CalendarTaskResponse = Components.Schemas.CalendarTaskResponse;
@@ -10613,6 +10806,7 @@ export type MessageRecord = Components.Schemas.MessageRecord;
 export type MessageAuthResult = Components.Schemas.MessageAuthResult;
 export type MessageProviderSpam = Components.Schemas.MessageProviderSpam;
 export type MessageFilterMove = Components.Schemas.MessageFilterMove;
+export type ClassifierScore = Components.Schemas.ClassifierScore;
 export type Message = Components.Schemas.Message;
 export type MessageSummaryResponse = Components.Schemas.MessageSummaryResponse;
 export type EnvelopeResponse = Components.Schemas.EnvelopeResponse;
@@ -10697,6 +10891,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;
@@ -10720,9 +10917,9 @@ export type ClassificationUnrunnableReason = Components.Schemas.ClassificationUn
 export type ClassificationLabel = Components.Schemas.ClassificationLabel;
 export type ClassificationFailureKind = Components.Schemas.ClassificationFailureKind;
 export type ClassificationField = Components.Schemas.ClassificationField;
+export type MessageCategory = Components.Schemas.MessageCategory;
 export type SortOrder = Components.Schemas.SortOrder;
 export type StarColor = Components.Schemas.StarColor;
-export type MessageCategory = Components.Schemas.MessageCategory;
 export type SenderTrust = Components.Schemas.SenderTrust;
 export type DisplayNameCorrespondence = Components.Schemas.DisplayNameCorrespondence;
 export type MessageStatus = Components.Schemas.MessageStatus;