@remit/api-openapi-spec 0.0.21 → 0.0.23

package/openapi.json

@@ -1968,6 +1968,80 @@
         }
       }
     },
+    "/messages/not-spam": {
+      "post": {
+        "operationId": "MessageBulkOperations_notSpam",
+        "description": "Undo a spam report: clear the sender's `blocked` flag (never promotes to trusted/wellknown) and move each message back to `Message.originalMailboxId`. Idempotent under a repeated call. Each message is processed independently and concurrently, so the request's total wait is bounded by one message's settle timeout rather than accumulating across the batch.",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.SpamReportBulkResult"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.BulkMessageInput"
+              }
+            }
+          }
+        },
+        "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"
+          }
+        }
+      }
+    },
+    "/messages/report-spam": {
+      "post": {
+        "operationId": "MessageBulkOperations_reportSpam",
+        "description": "Report messages as spam: block the sender (Address.flags.blocked) and move each message to the account's Junk folder. Skips the block (but still moves the message) when the sender is the account's own address. One call replaces composing the old separate `Block` and `Mark spam` actions — a single user intent, a single failure story. The sender block is written first and does not wait on the move; a failed move never rolls it back. Idempotent under a repeated call.",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.SpamReportBulkResult"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.BulkMessageInput"
+              }
+            }
+          }
+        },
+        "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"
+          }
+        }
+      }
+    },
     "/messages/{messageId}": {
       "get": {
         "operationId": "MessageOperations_describeMessage",
@@ -3577,6 +3651,24 @@
         },
         "description": "Body part information"
       },
+      "RemitImap.BulkMessageInput": {
+        "type": "object",
+        "required": [
+          "messageIds"
+        ],
+        "properties": {
+          "messageIds": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UUID"
+            },
+            "minItems": 1,
+            "maxItems": 100,
+            "description": "List of message IDs to operate on"
+          }
+        },
+        "description": "Input for bulk message operations"
+      },
       "RemitImap.BulkUpdateFlagsInput": {
         "type": "object",
         "required": [
@@ -4170,6 +4262,16 @@
         },
         "description": "Complete message description including all related data. Body content is delivered via the per-part `BodyPartResponse.contentUrl` (CloudFront, JWT-authorized at the edge); the legacy `bodyText`/`bodyHtml` fields were removed once content delivery cut over end-to-end (#224)."
       },
+      "RemitImap.DisplayNameCorrespondence": {
+        "type": "string",
+        "enum": [
+          "Corresponds",
+          "Lookalike",
+          "Unrelated",
+          "NoClaim"
+        ],
+        "description": "How the From display name relates to the From domain. `Corresponds` — the name is contained in the domain. `Lookalike` — the name is one or two characters away from a domain label. `Unrelated` — no relation. `NoClaim` — the name is empty or is the address itself, so it claims no identity."
+      },
       "RemitImap.EmptyTrashResponse": {
         "type": "object",
         "required": [
@@ -4892,6 +4994,21 @@
           "dkimMismatch": {
             "type": "boolean",
             "description": "True when DKIM signing domain(s) are present and none aligns with the From domain"
+          },
+          "displayNameCorrespondence": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.DisplayNameCorrespondence"
+              }
+            ],
+            "description": "How the From display name relates to the From domain. Present only for a message the provider's own filter already classified as spam, and only when the sender is not bulk-shaped (no List-Unsubscribe) — absence means the comparison was never made, never that it found nothing."
+          },
+          "offDomainLinkDomains": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Registrable domains (eTLD+1) the body's links point at, excluding the From address's own registrable domain. Present only for a message the provider's own filter already classified as spam; an empty array means every link stayed on the sender's domain, absence means the comparison was never made."
           }
         },
         "description": "Structured sender-authenticity signal, derived from headers at classification time. Absent for messages classified before this field was introduced — clients should treat absence as no-signal."
@@ -4961,6 +5078,20 @@
         },
         "description": "Message reference response for In-Reply-To and References headers"
       },
+      "RemitImap.MessageSpamReport": {
+        "type": "object",
+        "required": [
+          "reportedAt"
+        ],
+        "properties": {
+          "reportedAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "Timestamp (epoch millis) the report was made."
+          }
+        },
+        "description": "Recorded when the user reported this message as spam via `POST /messages/report-spam`. Present means the report stands; absent means never reported, or reported and then undone via `POST /messages/not-spam` (which clears it). Backs the \"Reported as spam · Undo\" affordance independent of the message's current folder — the underlying move can settle, fail, or no-op (already in Junk) without changing whether the report itself is shown."
+      },
       "RemitImap.MessageSummaryResponse": {
         "type": "object",
         "required": [
@@ -5037,6 +5168,14 @@
               "$ref": "#/components/schemas/RemitImap.LabelSummaryResponse"
             },
             "description": "Labels applied to this message — filter-, organize-, and manually-applied alike (issue #26). Absent/empty means no label is applied."
+          },
+          "spamReport": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.MessageSpamReport"
+              }
+            ],
+            "description": "Present when the user reported this message as spam and the report has not been undone. Backs the \"Reported as spam · Undo\" affordance."
           }
         },
         "description": "Core message metadata for API responses"
@@ -5899,6 +6038,55 @@
         ],
         "description": "Sort order for list operations"
       },
+      "RemitImap.SpamReportBulkResult": {
+        "type": "object",
+        "required": [
+          "successCount",
+          "failureCount"
+        ],
+        "properties": {
+          "successCount": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Number of items accepted for processing"
+          },
+          "failureCount": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Number of items rejected before processing"
+          },
+          "failures": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.SpamReportFailure"
+            },
+            "description": "One entry per message that failed, naming why. Absent or empty when every message succeeded."
+          }
+        },
+        "description": "Result of a report-spam or not-spam bulk call. Extends the standard counts with a reason per failed message: a partial failure here is an expected, routine outcome (a move from a prior press still settling) the client should be able to explain, not just count."
+      },
+      "RemitImap.SpamReportFailure": {
+        "type": "object",
+        "required": [
+          "messageId",
+          "reason"
+        ],
+        "properties": {
+          "messageId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "The message that failed"
+          },
+          "reason": {
+            "type": "string",
+            "description": "Why it failed, safe to show the user as-is. One of a small allowlisted set of user-facing messages (e.g. \"has not settled yet\" while a prior move is still in flight) — never a raw internal error, which is logged server-side instead and never returned here. Not intended to be parsed programmatically."
+          }
+        },
+        "description": "One message's failure reason within a report-spam or not-spam bulk call."
+      },
       "RemitImap.StarColor": {
         "type": "string",
         "enum": [
@@ -6425,6 +6613,14 @@
               "$ref": "#/components/schemas/RemitImap.LabelSummaryResponse"
             },
             "description": "Labels applied to this message — filter-, organize-, and manually-applied alike (issue #26). Absent/empty means no label is applied."
+          },
+          "spamReport": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.MessageSpamReport"
+              }
+            ],
+            "description": "Present when the user reported this message as spam and the report has not been undone, projected from the underlying Message row. Backs the \"Reported as spam · Undo\" affordance in list views."
           }
         },
         "description": "Thread message item returned by list/search operations. `senderTrust` is attached at read time via batch-fetch so the inbox row can render its badge without a per-row round trip. `category` is served from the ThreadMessage row itself, which is also the row the category filter matches, so the badge and the filter cannot disagree."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",