@remit/api-openapi-spec 0.0.97 → 0.0.98

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": [
@@ -11939,7 +12090,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."
       },

package/package.json

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