@remit/api-openapi-spec 0.0.97 → 0.0.99

package/openapi.json

@@ -3969,6 +3969,63 @@
         }
       }
     },
+    "/classification-stats": {
+      "get": {
+        "operationId": "ClassificationStatsOperations_getClassificationStats",
+        "description": "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.",
+        "parameters": [
+          {
+            "name": "since",
+            "in": "query",
+            "required": true,
+            "description": "Start of the window, an ISO 8601 date-time with zone offset. Inclusive.",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.ClassifierStats"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "The request was refused as malformed or contradictory. `code` is\n`invalid_request` where nothing more specific is known, and the refusal's own\ntoken where there is one.\n\nThe calendar surface answers with the reason it read the request by:\n`invalid_window`, `invalid_scope`, `invalid_url_segment`, `url_segment_taken`,\n`unknown_time_zone` and `default_calendar_undeletable` on the collection and\nthe query, and, for a VCALENDAR it could not accept,\n`malformed_icalendar`, `not_a_calendar`, `unsupported_component`, `no_event`,\n`no_master_event`, `multiple_master_events`, `missing_uid`, `mismatched_uid`,\n`missing_dt_start`, `backwards_end`, `invalid_date_time`,\n`invalid_recurrence_rule`, `missing_recurrence_id`, `not_recurring`,\n`unknown_occurrence` and `unmovable_recurrence_rule`. The outbox answers `mail_sync_off` to a\nsend from an account whose `syncedServices` leave out `Mail`, with the\naccount in `details.accountId`.\n\n`errors` is present only when the request failed schema validation before any\nhandler ran, and names every field that was refused.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ValidationError"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "The request carried no usable credential. `code` is `unauthorized`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiError"
+                }
+              }
+            }
+          }
+        },
+        "x-amazon-apigateway-integration": {
+          "type": "aws_proxy",
+          "httpMethod": "POST",
+          "passthroughBehavior": "when_no_match",
+          "uri": {
+            "Fn::Sub": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:{{HandlerFunctionName}}/invocations"
+          }
+        }
+      }
+    },
     "/config": {
       "get": {
         "operationId": "ConfigOperations_getConfig",
@@ -9574,7 +9631,8 @@
           "Marketing",
           "Automated",
           "Transactional",
-          "Social"
+          "Social",
+          "ColdOutreach"
         ],
         "description": "A label a classification provider picks for a message: the junk verdicts, priority, and the message categories."
       },
@@ -9950,6 +10008,99 @@
         ],
         "description": "Where a classification setting's value comes from."
       },
+      "RemitImap.ClassifierCategoryCount": {
+        "type": "object",
+        "required": [
+          "category",
+          "count"
+        ],
+        "properties": {
+          "category": {
+            "$ref": "#/components/schemas/RemitImap.MessageCategory"
+          },
+          "count": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "description": "Examined messages in one category."
+      },
+      "RemitImap.ClassifierCorrections": {
+        "type": "object",
+        "required": [
+          "spamReportedNotJunk",
+          "categoryOverridden"
+        ],
+        "properties": {
+          "spamReportedNotJunk": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Messages the reader reported as spam whose stored scores held no confident `Spam` or `Phishing` score."
+          },
+          "categoryOverridden": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Senders whose `Address.flags.category` override was set on or after `since`."
+          }
+        },
+        "description": "Times the reader disagreed with the classifier since `since`."
+      },
+      "RemitImap.ClassifierLabelCount": {
+        "type": "object",
+        "required": [
+          "label",
+          "count"
+        ],
+        "properties": {
+          "label": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationLabel"
+          },
+          "count": {
+            "type": "integer",
+            "format": "int32"
+          }
+        },
+        "description": "Confident scores for one label."
+      },
+      "RemitImap.ClassifierStats": {
+        "type": "object",
+        "required": [
+          "since",
+          "examined",
+          "byCategory",
+          "byLabel",
+          "corrections"
+        ],
+        "properties": {
+          "since": {
+            "type": "string",
+            "description": "The start of the window, as the request gave it: an ISO 8601 date-time with zone offset."
+          },
+          "examined": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Messages that arrived on or after `since` whose body sync classified them."
+          },
+          "byCategory": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.ClassifierCategoryCount"
+            },
+            "description": "Examined messages per category; a category with none is absent."
+          },
+          "byLabel": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.ClassifierLabelCount"
+            },
+            "description": "Confident scores per label, over the examined messages; a label with none is absent."
+          },
+          "corrections": {
+            "$ref": "#/components/schemas/RemitImap.ClassifierCorrections"
+          }
+        },
+        "description": "The classifier's distribution and corrections over mail that arrived on or after `since`, across every account the caller holds."
+      },
       "RemitImap.ConfigDescriptionResponse": {
         "type": "object",
         "required": [
@@ -10494,7 +10645,6 @@
           "name",
           "scope",
           "matchOperator",
-          "literalClauses",
           "actionLabelId",
           "actionMailboxId"
         ],
@@ -10528,14 +10678,6 @@
             "description": "How literalClauses combine.",
             "default": "And"
           },
-          "literalClauses": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/RemitImap.FilterClause"
-            },
-            "minItems": 1,
-            "description": "Literal from/subject/has-words predicate clauses (RFC 031). A filter carries at least one."
-          },
           "actionLabelId": {
             "type": "string",
             "description": "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.",
@@ -10545,6 +10687,30 @@
             "type": "string",
             "description": "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.",
             "default": "None"
+          },
+          "priority": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Evaluation order (RFC 040). Lower runs first. Defaults to 0."
+          },
+          "stop": {
+            "type": "boolean",
+            "description": "When set, a match ends evaluation for that message after this filter's own actions (RFC 040, Sieve `stop`). Defaults to false."
+          },
+          "literalClauses": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.FilterClause"
+            },
+            "description": "Literal clauses combined by matchOperator. Send these or rule, never both."
+          },
+          "rule": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterRuleV1"
+              }
+            ],
+            "description": "The rule as a test tree (RFC 040). Send this or literalClauses, never both. The server caps a rule at 50 leaves and 5 levels."
           }
         },
         "description": "Input for creating a filter (RFC 034). `ttl` is omitted — it is derived\nserver-side from `expiresAt` when `scope` is `Temporary` (RFC 034 Decision\n1.3), never client-supplied. `state`, `ruleChangedAt`, and `filterId` are\nall server-derived and excluded by their Read-only visibility."
@@ -10562,10 +10728,13 @@
           "actionChangedAt",
           "matchOperator",
           "literalClauses",
+          "priority",
+          "stop",
           "actionLabelId",
           "actionMailboxId",
           "createdAt",
           "updatedAt",
+          "rule",
           "organizeJobId"
         ],
         "properties": {
@@ -10652,8 +10821,18 @@
             "items": {
               "$ref": "#/components/schemas/RemitImap.FilterClause"
             },
-            "minItems": 1,
-            "description": "Literal from/subject/has-words predicate clauses (RFC 031). A filter carries at least one."
+            "description": "Literal from/subject/has-words predicate clauses (RFC 031). Empty when the rule is not leaves under one allof or anyof."
+          },
+          "priority": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Evaluation order (RFC 040). Lower runs first; ties go to the newest actionChangedAt, then to filterId. The first move a message reaches wins.",
+            "default": 0
+          },
+          "stop": {
+            "type": "boolean",
+            "description": "When set, a match ends evaluation for that message after this filter's own actions (RFC 040, Sieve `stop`).",
+            "default": false
           },
           "actionLabelId": {
             "type": "string",
@@ -10675,6 +10854,14 @@
             "format": "int64",
             "readOnly": true
           },
+          "rule": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterRuleV1"
+              }
+            ],
+            "description": "The rule as a test tree (RFC 040). literalClauses mirrors it when it is leaves under one allof or anyof, and is empty otherwise."
+          },
           "organizeJobId": {
             "type": "string",
             "description": "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."
@@ -11141,6 +11328,81 @@
         },
         "description": "Message envelope (header metadata)"
       },
+      "RemitImap.FilterAddressTest": {
+        "type": "object",
+        "required": [
+          "test",
+          "match",
+          "part",
+          "key"
+        ],
+        "properties": {
+          "test": {
+            "type": "string",
+            "enum": [
+              "address"
+            ]
+          },
+          "match": {
+            "$ref": "#/components/schemas/RemitImap.FilterRuleMatch"
+          },
+          "part": {
+            "$ref": "#/components/schemas/RemitImap.FilterRuleAddressPart"
+          },
+          "key": {
+            "$ref": "#/components/schemas/String256"
+          }
+        },
+        "description": "Compares one part of the From address against one key (Sieve `address`). Reads `from` only."
+      },
+      "RemitImap.FilterAllOfTest": {
+        "type": "object",
+        "required": [
+          "test",
+          "tests"
+        ],
+        "properties": {
+          "test": {
+            "type": "string",
+            "enum": [
+              "allof"
+            ]
+          },
+          "tests": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.FilterTest"
+            },
+            "minItems": 1,
+            "maxItems": 50
+          }
+        },
+        "description": "Matches when every test in `tests` matches (Sieve `allof`)."
+      },
+      "RemitImap.FilterAnyOfTest": {
+        "type": "object",
+        "required": [
+          "test",
+          "tests"
+        ],
+        "properties": {
+          "test": {
+            "type": "string",
+            "enum": [
+              "anyof"
+            ]
+          },
+          "tests": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.FilterTest"
+            },
+            "minItems": 1,
+            "maxItems": 50
+          }
+        },
+        "description": "Matches when any test in `tests` matches (Sieve `anyof`)."
+      },
       "RemitImap.FilterClause": {
         "type": "object",
         "required": [
@@ -11189,6 +11451,55 @@
         ],
         "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.FilterHasWordsTest": {
+        "type": "object",
+        "required": [
+          "test",
+          "words"
+        ],
+        "properties": {
+          "test": {
+            "type": "string",
+            "enum": [
+              "hasWords"
+            ]
+          },
+          "words": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/String256"
+            }
+          }
+        },
+        "description": "Matches when every word occurs in the sender, the subject or the body."
+      },
+      "RemitImap.FilterHeaderTest": {
+        "type": "object",
+        "required": [
+          "test",
+          "match",
+          "header",
+          "key"
+        ],
+        "properties": {
+          "test": {
+            "type": "string",
+            "enum": [
+              "header"
+            ]
+          },
+          "match": {
+            "$ref": "#/components/schemas/RemitImap.FilterRuleMatch"
+          },
+          "header": {
+            "$ref": "#/components/schemas/RemitImap.FilterRuleHeader"
+          },
+          "key": {
+            "$ref": "#/components/schemas/String256"
+          }
+        },
+        "description": "Compares one header against one key (Sieve `header`)."
+      },
       "RemitImap.FilterMatchOperator": {
         "type": "string",
         "enum": [
@@ -11197,6 +11508,25 @@
         ],
         "description": "How a Filter's literalClauses combine (RFC 031 \"literal predicates, AND/OR\"). Ignored when literalClauses is empty."
       },
+      "RemitImap.FilterNotTest": {
+        "type": "object",
+        "required": [
+          "test",
+          "operand"
+        ],
+        "properties": {
+          "test": {
+            "type": "string",
+            "enum": [
+              "not"
+            ]
+          },
+          "operand": {
+            "$ref": "#/components/schemas/RemitImap.FilterTest"
+          }
+        },
+        "description": "Matches when `operand` does not (Sieve `not`)."
+      },
       "RemitImap.FilterResponse": {
         "type": "object",
         "required": [
@@ -11210,10 +11540,13 @@
           "actionChangedAt",
           "matchOperator",
           "literalClauses",
+          "priority",
+          "stop",
           "actionLabelId",
           "actionMailboxId",
           "createdAt",
-          "updatedAt"
+          "updatedAt",
+          "rule"
         ],
         "properties": {
           "filterId": {
@@ -11299,8 +11632,18 @@
             "items": {
               "$ref": "#/components/schemas/RemitImap.FilterClause"
             },
-            "minItems": 1,
-            "description": "Literal from/subject/has-words predicate clauses (RFC 031). A filter carries at least one."
+            "description": "Literal from/subject/has-words predicate clauses (RFC 031). Empty when the rule is not leaves under one allof or anyof."
+          },
+          "priority": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Evaluation order (RFC 040). Lower runs first; ties go to the newest actionChangedAt, then to filterId. The first move a message reaches wins.",
+            "default": 0
+          },
+          "stop": {
+            "type": "boolean",
+            "description": "When set, a match ends evaluation for that message after this filter's own actions (RFC 040, Sieve `stop`).",
+            "default": false
           },
           "actionLabelId": {
             "type": "string",
@@ -11321,10 +11664,64 @@
             "type": "integer",
             "format": "int64",
             "readOnly": true
+          },
+          "rule": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterRuleV1"
+              }
+            ],
+            "description": "The rule as a test tree (RFC 040). literalClauses mirrors it when it is leaves under one allof or anyof, and is empty otherwise."
           }
         },
         "description": "Filter item returned by list/get/create/update operations. `ttl` is internal bookkeeping (RFC 034 Decision 1.3) and not surfaced."
       },
+      "RemitImap.FilterRuleAddressPart": {
+        "type": "string",
+        "enum": [
+          "All",
+          "Localpart",
+          "Domain",
+          "RegistrableDomain"
+        ],
+        "description": "The part of the From address a FilterRule address test reads (RFC 040). `RegistrableDomain` is the public-suffix aware domain."
+      },
+      "RemitImap.FilterRuleHeader": {
+        "type": "string",
+        "enum": [
+          "From",
+          "Subject",
+          "ListId"
+        ],
+        "description": "The header a FilterRule header test reads (RFC 040). `ListId` is normalized as a `List-Id` filter clause is."
+      },
+      "RemitImap.FilterRuleMatch": {
+        "type": "string",
+        "enum": [
+          "Is",
+          "Contains"
+        ],
+        "description": "How a FilterRule header or address test compares its key (RFC 040, after Sieve's `:is` and `:contains`). Both fold case."
+      },
+      "RemitImap.FilterRuleV1": {
+        "type": "object",
+        "required": [
+          "version",
+          "test"
+        ],
+        "properties": {
+          "version": {
+            "type": "number",
+            "enum": [
+              1
+            ]
+          },
+          "test": {
+            "$ref": "#/components/schemas/RemitImap.FilterTest"
+          }
+        },
+        "description": "A rule whose test is the truth; the row's literal clauses are empty."
+      },
       "RemitImap.FilterScope": {
         "type": "string",
         "enum": [
@@ -11342,6 +11739,29 @@
         ],
         "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.FilterTest": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/RemitImap.FilterAllOfTest"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.FilterAnyOfTest"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.FilterNotTest"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.FilterHeaderTest"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.FilterAddressTest"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.FilterHasWordsTest"
+          }
+        ],
+        "description": "A node of a filter rule's test tree (RFC 040)."
+      },
       "RemitImap.FolderAppointment": {
         "type": "object",
         "required": [
@@ -11939,7 +12359,8 @@
           "marketing",
           "automated",
           "transactional",
-          "social"
+          "social",
+          "coldOutreach"
         ],
         "description": "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."
       },
@@ -14784,8 +15205,18 @@
             "items": {
               "$ref": "#/components/schemas/RemitImap.FilterClause"
             },
-            "minItems": 1,
-            "description": "Literal from/subject/has-words predicate clauses (RFC 031). A filter carries at least one."
+            "description": "Literal from/subject/has-words predicate clauses (RFC 031). Empty when the rule is not leaves under one allof or anyof."
+          },
+          "priority": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Evaluation order (RFC 040). Lower runs first; ties go to the newest actionChangedAt, then to filterId. The first move a message reaches wins.",
+            "default": 0
+          },
+          "stop": {
+            "type": "boolean",
+            "description": "When set, a match ends evaluation for that message after this filter's own actions (RFC 040, Sieve `stop`).",
+            "default": false
           },
           "actionLabelId": {
             "type": "string",
@@ -14796,6 +15227,14 @@
             "type": "string",
             "description": "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.",
             "default": "None"
+          },
+          "rule": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.FilterRuleV1"
+              }
+            ],
+            "description": "Replaces the rule (RFC 040). Never sent with matchOperator or literalClauses. The server caps a rule at 50 leaves and 5 levels."
           }
         },
         "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`/`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."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.97",
+  "version": "0.0.99",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec, and its precompiled request validators.",
   "exports": {
     ".": "./openapi.json",