@remit/api-openapi-types 0.0.26 → 0.0.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "type": "module",
   "main": "types.d.ts",
   "types": "types.d.ts",

package/types.d.ts

@@ -157,6 +157,22 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Status of an outbox message in the send queue
      */
     export type OutboxMessageStatus = "draft" | "queued" | "sending" | "sent" | "failed" | "blocked";
+    /**
+     * Where an attachment is between being promised and being sendable.
+
+There is no third state and no absence: a row exists from the moment room is
+claimed, so the cap can be enforced against rows in one transaction rather
+than against bytes that may or may not have landed yet.
+     */
+    export type OutboxAttachmentState = "Pending" | "Stored";
+    /**
+     * Why the server refused to reserve, or to accept, a file for a draft.
+
+Closed rather than free text: the composer renders its own copy for each
+member (naming the file, the size and the cap), so a refusal must be
+distinguishable from a network failure without parsing prose.
+     */
+    export type OutboxAttachmentRejectionReason = "EmptyFile" | "UnusableFilename" | "FileTooLarge" | "MessageTooLarge" | "TooManyAttachments" | "ReservationExpired" | "UploadMissing" | "SizeMismatch";
     /**
      * Message lifecycle status for move/delete operations
      */
@@ -244,6 +260,7 @@ current enum emitter anyway, so the wire contract uses the bare form.
     export type String800 = string;
     export type String32 = string;
     export type String256 = string;
+    export type String2048 = string;
     /**
      * A semantic version string (e.g. "1.10.0"). See https://semver.org.
 
@@ -257,7 +274,6 @@ zero-pad width `@semanticVersion` encodes with — a segment beyond that is
 a compile-time error rather than a value that silently sorts incorrectly.
      */
     export type SemanticVersion = string;
-    export type String2048 = string;
     export type String200 = string;
     export interface CognitoAuthorizer {
       /**
@@ -2795,11 +2811,100 @@ present only when `count=true`. Thread-specific so the shared `ResultList<T>`
       sentAt?: number;
       createdAt: number;
       updatedAt: number;
+      /**
+       * Files on this message. Empty when it carries none.
+       */
+      attachments: OutboxAttachmentResponse[];
+    }
+    /**
+     * A file on a draft, from the moment room is claimed for it.
+
+The row is the record: it is what the per-message cap is counted over, what
+says an object in storage belongs to a message, and what goes when the draft
+goes. Storage holds bytes and nothing else — an object no row names is
+garbage, which is the only thing the sweep needs to know.
+     */
+    export interface OutboxAttachment {
+      /**
+       * Primary identifier
+       */
+      outboxAttachmentId: UUID;
+      /**
+       * Draft this file belongs to
+       */
+      outboxMessageId: UUID;
+      /**
+       * Sending account, so the storage key can be rebuilt without a join
+       */
+      accountId: UUID;
+      /**
+       * Tenant scope, so every read can be scoped without a join
+       */
+      accountConfigId: UUID;
+      /**
+       * Filename as it will appear on the sent message, sanitized server-side
+       */
+      filename: String256;
+      /**
+       * Media type recorded at upload. Never trusted for rendering.
+       */
+      contentType: String256;
+      /**
+       * Bytes claimed at reservation, confirmed against storage once stored
+       */
+      sizeBytes: number;
+      /**
+       * Whether the bytes have arrived
+       */
+      state: OutboxAttachmentState;
+      /**
+       * Where the bytes live. Written at reservation so nothing has to derive it.
+       */
+      storageKey: String2048;
+      /**
+       * When a Pending reservation stops holding room. Zero once Stored.
+       */
+      reservationExpiresAt: number;
+      createdAt: number;
+      updatedAt: number;
+    }
+    /**
+     * A file on a draft, as the composer sees it
+     */
+    export interface OutboxAttachmentResponse {
+      /**
+       * Primary identifier
+       */
+      outboxAttachmentId: UUID;
+      /**
+       * Draft this file belongs to
+       */
+      outboxMessageId: UUID;
+      /**
+       * Filename as it will appear on the sent message, sanitized server-side
+       */
+      filename: String256;
+      /**
+       * Media type recorded at upload. Never trusted for rendering.
+       */
+      contentType: String256;
+      /**
+       * Bytes claimed at reservation, confirmed against storage once stored
+       */
+      sizeBytes: number;
+      /**
+       * Whether the bytes have arrived
+       */
+      state: OutboxAttachmentState;
     }
     /**
      * Input for updating a draft outbox message
      */
     export interface UpdateOutboxMessageInput {
+      /**
+       * The files this draft keeps. Anything left out is removed with its bytes.
+       */
+      attachmentIds?: UUID[];
       /**
        * Recipient addresses (To)
        */
@@ -2833,6 +2938,89 @@ present only when `count=true`. Thread-specific so the shared `ResultList<T>`
        */
       references?: string[];
     }
+    /**
+     * What the client intends to attach, before any bytes move
+     */
+    export interface MintOutboxAttachmentInput {
+      /**
+       * Filename as the sender picked it. Sanitized server-side.
+       */
+      filename: String256;
+      /**
+       * Media type the browser reported. Recorded, never trusted for rendering.
+       */
+      contentType: String256;
+      /**
+       * Exact size of the file. The upload is bound to this number.
+       */
+      sizeBytes: number;
+    }
+    /**
+     * A reservation and somewhere to put the bytes.
+
+`uploadUrl` is opaque: on a hosted deployment it addresses block storage
+directly and the bytes never traverse this API, on a self-hosted one it
+addresses this deployment's own upload route. A client PUTs the file to it
+either way and cannot tell which it received.
+     */
+    export interface MintOutboxAttachmentResponse {
+      /**
+       * Primary identifier, and the name the completion call uses
+       */
+      outboxAttachmentId: UUID;
+      /**
+       * Draft the file is reserved against
+       */
+      outboxMessageId: UUID;
+      /**
+       * Sanitized filename that will appear on the sent message
+       */
+      filename: String256;
+      /**
+       * Normalized media type
+       */
+      contentType: String256;
+      /**
+       * Reserved size. The upload must carry exactly this many bytes.
+       */
+      sizeBytes: number;
+      /**
+       * Where to PUT the raw bytes. Single use, one attachment, expires.
+       */
+      uploadUrl: String2048;
+      /**
+       * When the reservation and the upload URL both lapse
+       */
+      uploadExpiresAt: number;
+    }
+    /**
+     * Refusal response for an attachment
+     */
+    export interface OutboxAttachmentRejected {
+      statusCode: 400 | 413;
+      error: OutboxAttachmentRejection;
+    }
+    /**
+     * A file the server refused, with everything the composer needs to say why
+     */
+    export interface OutboxAttachmentRejection {
+      /**
+       * Machine-readable reason
+       */
+      reason: OutboxAttachmentRejectionReason;
+      /**
+       * Sentence naming the file, its size and the cap
+       */
+      message: String512;
+      /**
+       * Total bytes one message may carry
+       */
+      limitBytes: number;
+      /**
+       * Bytes already spoken for on this draft, uploaded or merely reserved
+       */
+      usedBytes: number;
+    }
     /**
      * Normalized email address per RFC 2822 Section 3.4.1. Addresses are deduplicated across messages within an account config.
      */
@@ -4798,6 +4986,26 @@ declare namespace Paths {
       export type $200 = void;
     }
   }
+  namespace MintOutboxAttachment {
+    export interface PathParameters {
+      outboxMessageId: Components.Schemas.UUID;
+    }
+    export type RequestBody = Components.Schemas.MintOutboxAttachmentInput;
+    namespace Responses {
+      export type $200 = void;
+      export type $200 = void;
+    }
+  }
+  namespace CompleteOutboxAttachment {
+    export interface PathParameters {
+      outboxMessageId: Components.Schemas.UUID;
+      outboxAttachmentId: Components.Schemas.UUID;
+    }
+    namespace Responses {
+      export type $200 = void;
+      export type $200 = void;
+    }
+  }
   namespace SearchAddresses {
     export interface QueryParameters {
       q: string;
@@ -5286,6 +5494,22 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.SendOutboxMessage.Responses.$200>;
+  /**
+   * mintOutboxAttachment - Reserve room on a draft for a file, and get somewhere to put it
+   */
+  'mintOutboxAttachment'(
+    parameters?: Parameters<Paths.MintOutboxAttachment.PathParameters> | null,
+    data?: Paths.MintOutboxAttachment.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.MintOutboxAttachment.Responses.$200 | Paths.MintOutboxAttachment.Responses.$200>;
+  /**
+   * completeOutboxAttachment - Confirm an uploaded file against the object storage now holds
+   */
+  'completeOutboxAttachment'(
+    parameters?: Parameters<Paths.CompleteOutboxAttachment.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.CompleteOutboxAttachment.Responses.$200 | Paths.CompleteOutboxAttachment.Responses.$200>;
   /**
    * searchAddresses - Search addresses for autocomplete
    */
@@ -5851,6 +6075,26 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.SendOutboxMessage.Responses.$200>;
   };
+  ['/outbox/{outboxMessageId}/attachments']: {
+    /**
+     * mintOutboxAttachment - Reserve room on a draft for a file, and get somewhere to put it
+     */
+    'post'(
+      parameters?: Parameters<Paths.MintOutboxAttachment.PathParameters> | null,
+      data?: Paths.MintOutboxAttachment.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.MintOutboxAttachment.Responses.$200 | Paths.MintOutboxAttachment.Responses.$200>;
+  };
+  ['/outbox/{outboxMessageId}/attachments/{outboxAttachmentId}/complete']: {
+    /**
+     * completeOutboxAttachment - Confirm an uploaded file against the object storage now holds
+     */
+    'post'(
+      parameters?: Parameters<Paths.CompleteOutboxAttachment.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.CompleteOutboxAttachment.Responses.$200 | Paths.CompleteOutboxAttachment.Responses.$200>;
+  };
   ['/addresses/search']: {
     /**
      * searchAddresses - Search addresses for autocomplete
@@ -6047,7 +6291,13 @@ export type SemanticSearchResult = Components.Schemas.SemanticSearchResult;
 export type CreateOutboxMessageInput = Components.Schemas.CreateOutboxMessageInput;
 export type OutboxMessage = Components.Schemas.OutboxMessage;
 export type OutboxMessageResponse = Components.Schemas.OutboxMessageResponse;
+export type OutboxAttachment = Components.Schemas.OutboxAttachment;
+export type OutboxAttachmentResponse = Components.Schemas.OutboxAttachmentResponse;
 export type UpdateOutboxMessageInput = Components.Schemas.UpdateOutboxMessageInput;
+export type MintOutboxAttachmentInput = Components.Schemas.MintOutboxAttachmentInput;
+export type MintOutboxAttachmentResponse = Components.Schemas.MintOutboxAttachmentResponse;
+export type OutboxAttachmentRejected = Components.Schemas.OutboxAttachmentRejected;
+export type OutboxAttachmentRejection = Components.Schemas.OutboxAttachmentRejection;
 export type Address = Components.Schemas.Address;
 export type AddressFlags = Components.Schemas.AddressFlags;
 export type TrustedFlag = Components.Schemas.TrustedFlag;
@@ -6139,6 +6389,8 @@ export type DisplayNameCorrespondence = Components.Schemas.DisplayNameCorrespond
 export type PlacementAction = Components.Schemas.PlacementAction;
 export type SemanticSearchChunkType = Components.Schemas.SemanticSearchChunkType;
 export type OutboxMessageStatus = Components.Schemas.OutboxMessageStatus;
+export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
+export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
 export type MessageStatus = Components.Schemas.MessageStatus;
 export type MessageSyncStatus = Components.Schemas.MessageSyncStatus;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;
@@ -6166,6 +6418,6 @@ export type String64 = Components.Schemas.String64;
 export type String800 = Components.Schemas.String800;
 export type String32 = Components.Schemas.String32;
 export type String256 = Components.Schemas.String256;
-export type SemanticVersion = Components.Schemas.SemanticVersion;
 export type String2048 = Components.Schemas.String2048;
+export type SemanticVersion = Components.Schemas.SemanticVersion;
 export type String200 = Components.Schemas.String200;