@remit/api-openapi-spec 0.0.24 → 0.0.25

package/openapi.json

@@ -2371,6 +2371,136 @@
         }
       }
     },
+    "/outbox/{outboxMessageId}/attachments": {
+      "post": {
+        "operationId": "OutboxDetailOperations_mintOutboxAttachment",
+        "description": "Reserve room on a draft for a file, and get somewhere to put it",
+        "parameters": [
+          {
+            "name": "outboxMessageId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.MintOutboxAttachmentResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Refusal response for an attachment",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.OutboxAttachmentRejection"
+                }
+              }
+            }
+          },
+          "413": {
+            "description": "Refusal response for an attachment",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.OutboxAttachmentRejection"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RemitImap.MintOutboxAttachmentInput"
+              }
+            }
+          }
+        },
+        "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"
+          }
+        }
+      }
+    },
+    "/outbox/{outboxMessageId}/attachments/{outboxAttachmentId}/complete": {
+      "post": {
+        "operationId": "OutboxAttachmentOperations_completeOutboxAttachment",
+        "description": "Confirm an uploaded file against the object storage now holds",
+        "parameters": [
+          {
+            "name": "outboxMessageId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          },
+          {
+            "name": "outboxAttachmentId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/UUID"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.OutboxAttachmentResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Refusal response for an attachment",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.OutboxAttachmentRejection"
+                }
+              }
+            }
+          },
+          "413": {
+            "description": "Refusal response for an attachment",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RemitImap.OutboxAttachmentRejection"
+                }
+              }
+            }
+          }
+        },
+        "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"
+          }
+        }
+      }
+    },
     "/outbox/{outboxMessageId}/send": {
       "post": {
         "operationId": "OutboxDetailOperations_sendOutboxMessage",
@@ -5187,6 +5317,105 @@
         },
         "description": "Core message metadata for API responses"
       },
+      "RemitImap.MintOutboxAttachmentInput": {
+        "type": "object",
+        "required": [
+          "filename",
+          "contentType",
+          "sizeBytes"
+        ],
+        "properties": {
+          "filename": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Filename as the sender picked it. Sanitized server-side."
+          },
+          "contentType": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Media type the browser reported. Recorded, never trusted for rendering."
+          },
+          "sizeBytes": {
+            "type": "integer",
+            "format": "int64",
+            "minimum": 1,
+            "description": "Exact size of the file. The upload is bound to this number."
+          }
+        },
+        "description": "What the client intends to attach, before any bytes move"
+      },
+      "RemitImap.MintOutboxAttachmentResponse": {
+        "type": "object",
+        "required": [
+          "outboxAttachmentId",
+          "outboxMessageId",
+          "filename",
+          "contentType",
+          "sizeBytes",
+          "uploadUrl",
+          "uploadExpiresAt"
+        ],
+        "properties": {
+          "outboxAttachmentId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Primary identifier, and the name the completion call uses"
+          },
+          "outboxMessageId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Draft the file is reserved against"
+          },
+          "filename": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Sanitized filename that will appear on the sent message"
+          },
+          "contentType": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Normalized media type"
+          },
+          "sizeBytes": {
+            "type": "integer",
+            "format": "int64",
+            "minimum": 1,
+            "description": "Reserved size. The upload must carry exactly this many bytes."
+          },
+          "uploadUrl": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String2048"
+              }
+            ],
+            "description": "Where to PUT the raw bytes. Single use, one attachment, expires."
+          },
+          "uploadExpiresAt": {
+            "type": "integer",
+            "format": "int64",
+            "description": "When the reservation and the upload URL both lapse"
+          }
+        },
+        "description": "A reservation and somewhere to put the bytes.\n\n`uploadUrl` is opaque: on a hosted deployment it addresses block storage\ndirectly and the bytes never traverse this API, on a self-hosted one it\naddresses this deployment's own upload route. A client PUTs the file to it\neither way and cannot tell which it received."
+      },
       "RemitImap.MoveMessagesInput": {
         "type": "object",
         "required": [
@@ -5482,6 +5711,134 @@
         },
         "description": "Response body for POST /accounts/{accountId}/organize/preview — the messages the same matcher would apply the action to, without applying it. Bounded server-side."
       },
+      "RemitImap.OutboxAttachmentRejection": {
+        "type": "object",
+        "required": [
+          "reason",
+          "message",
+          "limitBytes",
+          "usedBytes"
+        ],
+        "properties": {
+          "reason": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.OutboxAttachmentRejectionReason"
+              }
+            ],
+            "description": "Machine-readable reason"
+          },
+          "message": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String512"
+              }
+            ],
+            "description": "Sentence naming the file, its size and the cap"
+          },
+          "limitBytes": {
+            "type": "integer",
+            "format": "int64",
+            "minimum": 0,
+            "description": "Total bytes one message may carry"
+          },
+          "usedBytes": {
+            "type": "integer",
+            "format": "int64",
+            "minimum": 0,
+            "description": "Bytes already spoken for on this draft, uploaded or merely reserved"
+          }
+        },
+        "description": "A file the server refused, with everything the composer needs to say why"
+      },
+      "RemitImap.OutboxAttachmentRejectionReason": {
+        "type": "string",
+        "enum": [
+          "EmptyFile",
+          "UnusableFilename",
+          "FileTooLarge",
+          "MessageTooLarge",
+          "TooManyAttachments",
+          "ReservationExpired",
+          "UploadMissing",
+          "SizeMismatch"
+        ],
+        "description": "Why the server refused to reserve, or to accept, a file for a draft.\n\nClosed rather than free text: the composer renders its own copy for each\nmember (naming the file, the size and the cap), so a refusal must be\ndistinguishable from a network failure without parsing prose."
+      },
+      "RemitImap.OutboxAttachmentResponse": {
+        "type": "object",
+        "required": [
+          "outboxAttachmentId",
+          "outboxMessageId",
+          "filename",
+          "contentType",
+          "sizeBytes",
+          "state"
+        ],
+        "properties": {
+          "outboxAttachmentId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Primary identifier",
+            "readOnly": true
+          },
+          "outboxMessageId": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/UUID"
+              }
+            ],
+            "description": "Draft this file belongs to",
+            "readOnly": true
+          },
+          "filename": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Filename as it will appear on the sent message, sanitized server-side",
+            "readOnly": true
+          },
+          "contentType": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/String256"
+              }
+            ],
+            "description": "Media type recorded at upload. Never trusted for rendering.",
+            "readOnly": true
+          },
+          "sizeBytes": {
+            "type": "integer",
+            "format": "int64",
+            "minimum": 0,
+            "description": "Bytes claimed at reservation, confirmed against storage once stored",
+            "readOnly": true
+          },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/RemitImap.OutboxAttachmentState"
+              }
+            ],
+            "description": "Whether the bytes have arrived",
+            "readOnly": true
+          }
+        },
+        "description": "A file on a draft, as the composer sees it"
+      },
+      "RemitImap.OutboxAttachmentState": {
+        "type": "string",
+        "enum": [
+          "Pending",
+          "Stored"
+        ],
+        "description": "Where an attachment is between being promised and being sendable.\n\nThere is no third state and no absence: a row exists from the moment room is\nclaimed, so the cap can be enforced against rows in one transaction rather\nthan against bytes that may or may not have landed yet."
+      },
       "RemitImap.OutboxMessageResponse": {
         "type": "object",
         "required": [
@@ -5494,7 +5851,8 @@
           "references",
           "status",
           "createdAt",
-          "updatedAt"
+          "updatedAt",
+          "attachments"
         ],
         "properties": {
           "outboxMessageId": {
@@ -5609,6 +5967,13 @@
             "type": "integer",
             "format": "int64",
             "readOnly": true
+          },
+          "attachments": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.OutboxAttachmentResponse"
+            },
+            "description": "Files on this message. Empty when it carries none."
           }
         },
         "description": "Outbox message response"
@@ -7044,6 +7409,13 @@
       "RemitImap.UpdateOutboxMessageInput": {
         "type": "object",
         "properties": {
+          "attachmentIds": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UUID"
+            },
+            "description": "The files this draft keeps. Anything left out is removed with its bytes."
+          },
           "toAddresses": {
             "type": "array",
             "items": {
@@ -7227,6 +7599,10 @@
         "type": "string",
         "maxLength": 140
       },
+      "String2048": {
+        "type": "string",
+        "maxLength": 2048
+      },
       "String256": {
         "type": "string",
         "maxLength": 256

package/package.json

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