@remit/api-openapi-types 0.0.16 → 0.0.17

package/package.json

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

package/types.d.ts

@@ -117,6 +117,10 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Message attribute a FilterClause matches against — RFC 031's Tier 0 literal predicates plus the RFC 038 D2 additions (list membership and sender domain). Every member is matched vector-free at index time and in the back-apply corpus projection.
      */
     export type FilterClauseField = "From" | "Subject" | "HasWords" | "ListId" | "FromDomain";
+    /**
+     * Display color for a user-defined Label (RFC 030).
+     */
+    export type LabelColor = "Default" | "Red" | "Orange" | "Yellow" | "Green" | "Teal" | "Blue" | "Purple" | "Gray";
     /**
      * Lifecycle state of a smart-organize back-apply job (RFC 034, #1278). Mirrors the account-export job's lifecycle: a Pending row the worker picks up, drives to Running, then to a terminal Complete or Failed.
      */
@@ -189,6 +193,10 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Message reference types per RFC 2822 Section 3.6.4
      */
     export type ReferenceType = "in_reply_to" | "references";
+    /**
+     * Manual bulk label action (issue #26) — apply or remove a label on a `just these` selection. Never sets `appliedByFilterId`: that field is reserved for filter-driven applies (RFC 034 Decision 3.3).
+     */
+    export type LabelAction = "Apply" | "Remove";
     /**
      * System message flags defined in RFC 9051 Section 2.3.2 - MUST be supported by all servers
      */
@@ -213,10 +221,6 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * Known user-setting keys. Each maps, in the registry, to a required value kind and a zod schema. New keys are added deliberately by extending this enum and the registry — never as an ad-hoc column.
      */
     export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "MailboxRole";
-    /**
-     * Display color for a user-defined Label (RFC 030).
-     */
-    export type LabelColor = "Default" | "Red" | "Orange" | "Yellow" | "Green" | "Teal" | "Blue" | "Purple" | "Gray";
     /**
      * Explicit state engine for a pending placement-move marker (issue #1271, epic #1281). Recovery keys off this field, not control-flow inference: a redelivered/retried call drives a marker forward from whichever state it is actually in, rather than re-deriving intent by comparing the message's current location.
      */
@@ -1641,6 +1645,86 @@ anchor change through this body (reader #266).
        */
       actionMailboxId: string;
     }
+    /**
+     * A user-defined label definition, scoped to an account (RFC 030). labelId is a stable id; name is a separate mutable overlay, never the key.
+     */
+    export interface Label {
+      /**
+       * Primary identifier
+       */
+      labelId: UUID;
+      /**
+       * Owning account configuration
+       */
+      accountConfigId: UUID;
+      /**
+       * Human-readable label name (display)
+       */
+      name: String140;
+      /**
+       * Lowercased/trimmed form of name, used for dedupe via byNormalizedName
+       */
+      normalizedName: String140;
+      /**
+       * Display color for this label
+       */
+      color: LabelColor;
+      createdAt: number;
+      updatedAt: number;
+    }
+    /**
+     * Label item returned by list/get/create/update operations (RFC 030). `filterCount` is computed at read time so a client can name the blast radius before confirming a delete — the delete itself never blocks on it (issue #26).
+     */
+    export interface LabelResponse {
+      /**
+       * Primary identifier
+       */
+      labelId: UUID;
+      /**
+       * Owning account configuration
+       */
+      accountConfigId: UUID;
+      /**
+       * Human-readable label name (display)
+       */
+      name: String140;
+      /**
+       * Display color for this label
+       */
+      color: LabelColor;
+      createdAt: number;
+      updatedAt: number;
+      /**
+       * Number of the account's filters whose `actionLabelId` is this label. Deleting the label deletes every one of them (issue #26) — a client shows this count in its delete confirmation.
+       */
+      filterCount: number;
+    }
+    /**
+     * Input for creating a label (RFC 030). `normalizedName` is server-derived from `name` and excluded by its Read-only visibility.
+     */
+    export interface CreateLabelInput {
+      /**
+       * Human-readable label name (display)
+       */
+      name: String140;
+      /**
+       * Display color for this label
+       */
+      color: LabelColor;
+    }
+    /**
+     * Input for updating a label (RFC 030). Only `name` and `color` are mutable.
+     */
+    export interface UpdateLabelInput {
+      /**
+       * Human-readable label name (display)
+       */
+      name: String140;
+      /**
+       * Display color for this label
+       */
+      color: LabelColor;
+    }
     /**
      * The predicate + action for a one-time "all like these" back-apply (RFC 034
 recap, #1278). A distinct model, deliberately NOT a Filter: it carries no
@@ -2348,6 +2432,10 @@ standing to persist.
        * Present only when Remit auto-moved this message on body-sync. Absent means the message was not auto-moved by Remit.
        */
       autoMoved?: AutoMovedInfo;
+      /**
+       * Labels applied to this message — filter-, organize-, and manually-applied alike (issue #26). Absent/empty means no label is applied.
+       */
+      labels?: LabelSummaryResponse[];
     }
     /**
      * 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.
@@ -2391,6 +2479,14 @@ standing to persist.
        */
       filterId?: UUID;
     }
+    /**
+     * The id, name, and color of a label applied to a message — embedded on message/thread read responses (issue #26). Never the full LabelResponse: a read-time attachment carries no filterCount.
+     */
+    export interface LabelSummaryResponse {
+      labelId: UUID;
+      name: String140;
+      color: LabelColor;
+    }
     /**
      * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
 pagination `continuationToken`, and an optional `count` of matches within the
@@ -3236,6 +3332,10 @@ server-capped window. `items` is omitted when `results=false` (count-only);
        * Present only when Remit auto-moved this message on body-sync. Absent means the message was not auto-moved by Remit.
        */
       autoMoved?: AutoMovedInfo;
+      /**
+       * Labels applied to this message — filter-, organize-, and manually-applied alike (issue #26). Absent/empty means no label is applied.
+       */
+      labels?: LabelSummaryResponse[];
     }
     /**
      * Message envelope (header metadata)
@@ -3591,6 +3691,23 @@ server-capped window. `items` is omitted when `results=false` (count-only);
        */
       destinationMailboxId: UUID;
     }
+    /**
+     * Input for a manual bulk label action — the "just these" scope (RFC 034 recap). `appliedByFilterId` never gets set on the resulting `MessageLabel` rows; that provenance is reserved for filter/organize applies (RFC 034 Decision 3.3).
+     */
+    export interface UpdateMessageLabelsInput {
+      /**
+       * List of message IDs to operate on
+       */
+      messageIds: UUID[];
+      /**
+       * Label to apply or remove
+       */
+      labelId: UUID;
+      /**
+       * Whether to apply or remove the label
+       */
+      action: LabelAction;
+    }
     /**
      * Junction table linking envelope addresses to normalized addresses. Stores per-message display name since it may vary.
      */
@@ -4088,33 +4205,6 @@ locally".
       createdAt: number;
       updatedAt: number;
     }
-    /**
-     * A user-defined label definition, scoped to an account (RFC 030). labelId is a stable id; name is a separate mutable overlay, never the key.
-     */
-    export interface Label {
-      /**
-       * Primary identifier
-       */
-      labelId: UUID;
-      /**
-       * Owning account configuration
-       */
-      accountConfigId: UUID;
-      /**
-       * Human-readable label name (display)
-       */
-      name: String140;
-      /**
-       * Lowercased/trimmed form of name, used for dedupe via byNormalizedName
-       */
-      normalizedName: String140;
-      /**
-       * Display color for this label
-       */
-      color: LabelColor;
-      createdAt: number;
-      updatedAt: number;
-    }
     /**
      * Junction whose existence *is* a label assignment (RFC 030). Holds only ids
 and is hydrated with `batchGet`. Keyed by a deterministic UUID v5 derived
@@ -4354,6 +4444,53 @@ declare namespace Paths {
     namespace Responses {
     }
   }
+  namespace ListLabels {
+    export interface PathParameters {
+      accountId: Components.Schemas.UUID;
+    }
+    export interface QueryParameters {
+      continuationToken?: string;
+    }
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
+  namespace CreateLabel {
+    export interface PathParameters {
+      accountId: Components.Schemas.UUID;
+    }
+    export type RequestBody = Components.Schemas.CreateLabelInput;
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
+  namespace GetLabel {
+    export interface PathParameters {
+      accountId: Components.Schemas.UUID;
+      labelId: Components.Schemas.UUID;
+    }
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
+  namespace UpdateLabel {
+    export interface PathParameters {
+      accountId: Components.Schemas.UUID;
+      labelId: Components.Schemas.UUID;
+    }
+    export type RequestBody = Components.Schemas.UpdateLabelInput;
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
+  namespace DeleteLabel {
+    export interface PathParameters {
+      accountId: Components.Schemas.UUID;
+      labelId: Components.Schemas.UUID;
+    }
+    namespace Responses {
+    }
+  }
   namespace CreateOrganizeJob {
     export interface PathParameters {
       accountId: Components.Schemas.UUID;
@@ -4638,6 +4775,12 @@ declare namespace Paths {
       export type $200 = void;
     }
   }
+  namespace UpdateMessageLabels {
+    export type RequestBody = Components.Schemas.UpdateMessageLabelsInput;
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
 }
 
 export interface OperationMethods {
@@ -4793,6 +4936,46 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<any>;
+  /**
+   * listLabels
+   */
+  'listLabels'(
+    parameters?: Parameters<Paths.ListLabels.PathParameters & Paths.ListLabels.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.ListLabels.Responses.$200>;
+  /**
+   * createLabel
+   */
+  'createLabel'(
+    parameters?: Parameters<Paths.CreateLabel.PathParameters> | null,
+    data?: Paths.CreateLabel.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.CreateLabel.Responses.$200>;
+  /**
+   * getLabel
+   */
+  'getLabel'(
+    parameters?: Parameters<Paths.GetLabel.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.GetLabel.Responses.$200>;
+  /**
+   * updateLabel
+   */
+  'updateLabel'(
+    parameters?: Parameters<Paths.UpdateLabel.PathParameters> | null,
+    data?: Paths.UpdateLabel.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.UpdateLabel.Responses.$200>;
+  /**
+   * deleteLabel - Delete a label. Cascades in both directions (issue #26): every `MessageLabel` row for it is removed, and every filter whose `actionLabelId` is this label is deleted outright — never left dangling, never blocking the delete. The client is expected to confirm first, naming `LabelResponse.filterCount` as the number of filters that will go with it.
+   */
+  'deleteLabel'(
+    parameters?: Parameters<Paths.DeleteLabel.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<any>;
   /**
    * createOrganizeJob - Start a one-time "all like these" back-apply: match the corpus against the given predicate and apply the action to every match, in one pass. Returns immediately with an organizeJobId; poll GET /accounts/{accountId}/organize/{organizeJobId} for state and counts. Never creates a Filter or FilterAnchor row (RFC 034 recap).
    */
@@ -5073,6 +5256,14 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
     data?: Paths.CopyMessages.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.CopyMessages.Responses.$200>;
+  /**
+   * updateMessageLabels - Apply or remove a label on multiple messages — the manual "just these" scope (RFC 034 recap, issue #26). `appliedByFilterId` stays absent on the resulting `MessageLabel` rows; that provenance is reserved for filter/organize applies.
+   */
+  'updateMessageLabels'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.UpdateMessageLabels.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.UpdateMessageLabels.Responses.$200>;
 }
 
 export interface PathsDictionary {
@@ -5252,6 +5443,50 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<any>;
   };
+  ['/accounts/{accountId}/labels']: {
+    /**
+     * listLabels
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListLabels.PathParameters & Paths.ListLabels.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.ListLabels.Responses.$200>;
+    /**
+     * createLabel
+     */
+    'post'(
+      parameters?: Parameters<Paths.CreateLabel.PathParameters> | null,
+      data?: Paths.CreateLabel.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.CreateLabel.Responses.$200>;
+  };
+  ['/accounts/{accountId}/labels/{labelId}']: {
+    /**
+     * getLabel
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetLabel.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.GetLabel.Responses.$200>;
+    /**
+     * updateLabel
+     */
+    'patch'(
+      parameters?: Parameters<Paths.UpdateLabel.PathParameters> | null,
+      data?: Paths.UpdateLabel.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.UpdateLabel.Responses.$200>;
+    /**
+     * deleteLabel - Delete a label. Cascades in both directions (issue #26): every `MessageLabel` row for it is removed, and every filter whose `actionLabelId` is this label is deleted outright — never left dangling, never blocking the delete. The client is expected to confirm first, naming `LabelResponse.filterCount` as the number of filters that will go with it.
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteLabel.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<any>;
+  };
   ['/accounts/{accountId}/organize']: {
     /**
      * createOrganizeJob - Start a one-time "all like these" back-apply: match the corpus against the given predicate and apply the action to every match, in one pass. Returns immediately with an organizeJobId; poll GET /accounts/{accountId}/organize/{organizeJobId} for state and counts. Never creates a Filter or FilterAnchor row (RFC 034 recap).
@@ -5588,6 +5823,16 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.CopyMessages.Responses.$200>;
   };
+  ['/messages/labels']: {
+    /**
+     * updateMessageLabels - Apply or remove a label on multiple messages — the manual "just these" scope (RFC 034 recap, issue #26). `appliedByFilterId` stays absent on the resulting `MessageLabel` rows; that provenance is reserved for filter/organize applies.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.UpdateMessageLabels.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.UpdateMessageLabels.Responses.$200>;
+  };
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>;
@@ -5635,6 +5880,10 @@ export type FilterClause = Components.Schemas.FilterClause;
 export type FilterResponse = Components.Schemas.FilterResponse;
 export type CreateFilterInput = Components.Schemas.CreateFilterInput;
 export type UpdateFilterInput = Components.Schemas.UpdateFilterInput;
+export type Label = Components.Schemas.Label;
+export type LabelResponse = Components.Schemas.LabelResponse;
+export type CreateLabelInput = Components.Schemas.CreateLabelInput;
+export type UpdateLabelInput = Components.Schemas.UpdateLabelInput;
 export type OrganizeInput = Components.Schemas.OrganizeInput;
 export type CreateOrganizeJobResponse = Components.Schemas.CreateOrganizeJobResponse;
 export type OrganizePreviewResponse = Components.Schemas.OrganizePreviewResponse;
@@ -5653,6 +5902,7 @@ export type ThreadMessage = Components.Schemas.ThreadMessage;
 export type ThreadMessageResponse = Components.Schemas.ThreadMessageResponse;
 export type MessageAuthenticity = Components.Schemas.MessageAuthenticity;
 export type AutoMovedInfo = Components.Schemas.AutoMovedInfo;
+export type LabelSummaryResponse = Components.Schemas.LabelSummaryResponse;
 export type ThreadSearchResponse = Components.Schemas.ThreadSearchResponse;
 export type SemanticSearchResult = Components.Schemas.SemanticSearchResult;
 export type CreateOutboxMessageInput = Components.Schemas.CreateOutboxMessageInput;
@@ -5692,6 +5942,7 @@ export type DeleteMessagesInput = Components.Schemas.DeleteMessagesInput;
 export type BulkMessageInput = Components.Schemas.BulkMessageInput;
 export type MoveMessagesInput = Components.Schemas.MoveMessagesInput;
 export type CopyMessagesInput = Components.Schemas.CopyMessagesInput;
+export type UpdateMessageLabelsInput = Components.Schemas.UpdateMessageLabelsInput;
 export type EnvelopeAddress = Components.Schemas.EnvelopeAddress;
 export type AccountSettingValue = Components.Schemas.AccountSettingValue;
 export type BooleanSetting = Components.Schemas.BooleanSetting;
@@ -5713,7 +5964,6 @@ export type BodyPartParameter = Components.Schemas.BodyPartParameter;
 export type RawMessageStorage = Components.Schemas.RawMessageStorage;
 export type BodyPartStorage = Components.Schemas.BodyPartStorage;
 export type BodyPartContent = Components.Schemas.BodyPartContent;
-export type Label = Components.Schemas.Label;
 export type MessageLabel = Components.Schemas.MessageLabel;
 export type FilterAnchor = Components.Schemas.FilterAnchor;
 export type MicrosoftOAuthStartRequest = Components.Schemas.MicrosoftOAuthStartRequest;
@@ -5738,6 +5988,7 @@ export type FilterScope = Components.Schemas.FilterScope;
 export type FilterState = Components.Schemas.FilterState;
 export type FilterMatchOperator = Components.Schemas.FilterMatchOperator;
 export type FilterClauseField = Components.Schemas.FilterClauseField;
+export type LabelColor = Components.Schemas.LabelColor;
 export type OrganizeJobState = Components.Schemas.OrganizeJobState;
 export type SortOrder = Components.Schemas.SortOrder;
 export type StarColor = Components.Schemas.StarColor;
@@ -5756,13 +6007,13 @@ export type TransferEncoding = Components.Schemas.TransferEncoding;
 export type ContentDisposition = Components.Schemas.ContentDisposition;
 export type MultipartSubtype = Components.Schemas.MultipartSubtype;
 export type ReferenceType = Components.Schemas.ReferenceType;
+export type LabelAction = Components.Schemas.LabelAction;
 export type MessageSystemFlag = Components.Schemas.MessageSystemFlag;
 export type MessageKeywordFlag = Components.Schemas.MessageKeywordFlag;
 export type MailboxAttribute = Components.Schemas.MailboxAttribute;
 export type StorageType = Components.Schemas.StorageType;
 export type ContentEncoding = Components.Schemas.ContentEncoding;
 export type AccountSettingName = Components.Schemas.AccountSettingName;
-export type LabelColor = Components.Schemas.LabelColor;
 export type MessagePlacementMoveState = Components.Schemas.MessagePlacementMoveState;
 export type FlagPushOperation = Components.Schemas.FlagPushOperation;
 export type MessageFlagPushState = Components.Schemas.MessageFlagPushState;