@remit/api-openapi-spec 0.0.85 → 0.0.87

package/openapi.json

@@ -6559,6 +6559,63 @@
         }
       }
     },
+    "/settings/classification-test": {
+      "post": {
+        "operationId": "UserSettingsOperations_testClassificationProvider",
+        "description": "Classify one built-in sample message with the form values, saved or not, and answer with the label or the failure. An empty key uses the saved key. Saved settings stay as they were, and the call counts toward no daily limit.",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.ClassificationTestResponse"
+                }
+              }
+            }
+          },
+          "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"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.ClassificationTestInput"
+              }
+            }
+          }
+        },
+        "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"
+          }
+        }
+      }
+    },
     "/settings/default-invitation-sender": {
       "delete": {
         "operationId": "UserSettingsOperations_clearDefaultInvitationSender",
@@ -9404,7 +9461,8 @@
           "apiKeySaved",
           "enabled",
           "dailyLimit",
-          "savedAt"
+          "savedAt",
+          "usage"
         ],
         "properties": {
           "state": {
@@ -9439,10 +9497,93 @@
             "type": "integer",
             "format": "int64",
             "description": "When the provider, model, base URL or key was last saved, in epoch milliseconds (UTC)."
+          },
+          "usage": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.ClassificationUsage"
+            },
+            "description": "Today's provider calls, one row per mail account of the account config."
           }
         },
         "description": "The saved classification provider. The API key itself is never returned."
       },
+      "RemitImap.ClassificationCost": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/RemitImap.ClassificationCostPriced"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.ClassificationNoPrice"
+          }
+        ]
+      },
+      "RemitImap.ClassificationCostPriced": {
+        "type": "object",
+        "required": [
+          "state",
+          "currency",
+          "amount"
+        ],
+        "properties": {
+          "state": {
+            "type": "string",
+            "enum": [
+              "Priced"
+            ]
+          },
+          "currency": {
+            "type": "string",
+            "enum": [
+              "USD"
+            ],
+            "description": "ISO 4217 currency of `amount`."
+          },
+          "amount": {
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "description": "The cost of today's calls, counting each call as 1,500 input tokens at the preset's price."
+      },
+      "RemitImap.ClassificationFailureKind": {
+        "type": "string",
+        "enum": [
+          "Unauthorized",
+          "ModelNotFound",
+          "RateLimited",
+          "Rejected",
+          "ProviderError",
+          "Unreachable",
+          "TimedOut",
+          "Unparseable"
+        ],
+        "description": "Why a classification provider call gave no usable answer."
+      },
+      "RemitImap.ClassificationField": {
+        "type": "string",
+        "enum": [
+          "ApiKey",
+          "Model",
+          "BaseUrl"
+        ],
+        "description": "The classification provider form field a failure points at."
+      },
+      "RemitImap.ClassificationLabel": {
+        "type": "string",
+        "enum": [
+          "Spam",
+          "Phishing",
+          "Priority",
+          "Personal",
+          "Newsletter",
+          "Marketing",
+          "Automated",
+          "Transactional",
+          "Social"
+        ],
+        "description": "A label a classification provider picks for a message: the junk verdicts, priority, and the message categories."
+      },
       "RemitImap.ClassificationNoPrice": {
         "type": "object",
         "required": [
@@ -9585,6 +9726,156 @@
           }
         ]
       },
+      "RemitImap.ClassificationTestFailed": {
+        "type": "object",
+        "required": [
+          "state",
+          "latencyMs",
+          "kind",
+          "fix"
+        ],
+        "properties": {
+          "state": {
+            "type": "string",
+            "enum": [
+              "Failed"
+            ]
+          },
+          "latencyMs": {
+            "type": "integer",
+            "format": "int32",
+            "description": "How long the provider call took, in milliseconds."
+          },
+          "status": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The HTTP status the provider answered with. Absent when no answer arrived."
+          },
+          "kind": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationFailureKind"
+          },
+          "field": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.ClassificationField"
+              }
+            ],
+            "description": "The form field to change. Absent when no field can fix it: a rate limit or a provider error."
+          },
+          "fix": {
+            "type": "string",
+            "description": "What to change so the next test passes."
+          }
+        },
+        "description": "The provider call gave no usable answer."
+      },
+      "RemitImap.ClassificationTestInput": {
+        "type": "object",
+        "required": [
+          "presetId",
+          "model",
+          "baseUrl",
+          "apiKey"
+        ],
+        "properties": {
+          "presetId": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationPresetId"
+          },
+          "model": {
+            "type": "string",
+            "description": "The model to ask for. Empty means the preset's default model."
+          },
+          "baseUrl": {
+            "type": "string",
+            "description": "The http or https base URL to call. Empty means the preset's default base URL."
+          },
+          "apiKey": {
+            "type": "string",
+            "description": "The provider's API key. Empty means the key saved for this preset."
+          }
+        },
+        "description": "The classification provider form as it stands, saved or not."
+      },
+      "RemitImap.ClassificationTestPassed": {
+        "type": "object",
+        "required": [
+          "state",
+          "latencyMs",
+          "label",
+          "confidence"
+        ],
+        "properties": {
+          "state": {
+            "type": "string",
+            "enum": [
+              "Passed"
+            ]
+          },
+          "latencyMs": {
+            "type": "integer",
+            "format": "int32",
+            "description": "How long the provider call took, in milliseconds."
+          },
+          "label": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.ClassificationLabel"
+              }
+            ],
+            "description": "The label the provider chose for the sample message."
+          },
+          "confidence": {
+            "type": "number",
+            "format": "double",
+            "description": "The provider's confidence in `label`, between 0 and 1."
+          }
+        },
+        "description": "The provider classified the sample message."
+      },
+      "RemitImap.ClassificationTestResponse": {
+        "anyOf": [
+          {
+            "$ref": "#/components/schemas/RemitImap.ClassificationTestPassed"
+          },
+          {
+            "$ref": "#/components/schemas/RemitImap.ClassificationTestFailed"
+          }
+        ]
+      },
+      "RemitImap.ClassificationUsage": {
+        "type": "object",
+        "required": [
+          "accountId",
+          "calls",
+          "dailyLimit",
+          "resetsAt",
+          "cost"
+        ],
+        "properties": {
+          "accountId": {
+            "$ref": "#/components/schemas/UUID"
+          },
+          "calls": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Provider calls made today (UTC). Test calls do not count."
+          },
+          "dailyLimit": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The most calls this mail account makes per UTC day."
+          },
+          "resetsAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "When `calls` restarts at zero: the next 00:00 UTC."
+          },
+          "cost": {
+            "$ref": "#/components/schemas/RemitImap.ClassificationCost"
+          }
+        },
+        "description": "One mail account's classification calls today."
+      },
       "RemitImap.ConfigDescriptionResponse": {
         "type": "object",
         "required": [

package/package.json

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