@remit/api-openapi-types 0.0.32 → 0.0.34

package/package.json

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

package/types.d.ts

@@ -69,6 +69,10 @@ writer can reach is a vocabulary that lies about what the field means.
      * Phase of the initial account sync lifecycle
      */
     export type SyncPhase = "idle" | "discovering_mailboxes" | "syncing_inbox" | "syncing_others" | "complete" | "error";
+    /**
+     * Where a resolved FolderAppointment came from. Total and required: every role carries one, so a surface can tell a folder somebody chose from a folder reader guessed without inferring it from which fields happen to be present.
+     */
+    export type FolderAppointmentSource = "Appointed" | "Flagged" | "Reserved" | "Proposed" | "Stale" | "None";
     /**
      * Outcome of the most recent manifest check. `ok` when a manifest was fetched and validated, `failed` when it could not be, `disabled` when no manifest URL is configured or no check has ever run (RFC 037 D8).
      */
@@ -244,7 +248,7 @@ distinguishable from a network failure without parsing prose.
     /**
      * 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" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "MailboxRole";
+    export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "FolderRoleAppointmentLabel" | "MailboxRole";
     /**
      * 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.
      */
@@ -329,6 +333,48 @@ a compile-time error rather than a value that silently sorts incorrectly.
       continuationToken?: String800;
       items: any[];
     }
+    /**
+     * An action was refused because the folder role it needs is not settled. The body is flat: `code`, `message` and `details` sit at the top level, which is what the API emits. Clients branch on `code` and word their prompt from `details`, never from `message`.
+
+`code: "folder_role_unresolved"` — no folder holds the role this action needs. `details` carries `role`, `accountId`, and `reason`, one of: `none` (the account has no candidate folder), `stale` (the folder the user appointed is gone from the mail server), `unconfirmed` (a folder matches by name, but neither the user nor the server's own flag ever said it holds the role).
+     */
+    export interface FolderRoleConflict {
+      statusCode: 409;
+      /**
+       * Error code
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
+    /**
+     * The same flat 409 body as `FolderRoleConflict`, with one code only this endpoint can answer with.
+
+`code: "folder_role_unresolved"` — as everywhere else, with `details` carrying `role`, `accountId` and `reason`.
+
+`code: "mailbox_not_settled"` — the mailbox being appointed is still being created or deleted on the mail server, so it cannot yet hold a role. `details` carries `mailboxId` and `syncStatus`. Clearing a role is never refused this way.
+     */
+    export interface AppointFolderRoleConflict {
+      statusCode: 409;
+      /**
+       * Error code
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
     export interface AmazonApiGatewayIntegration {
       type: "aws_proxy";
       httpMethod: "POST";
@@ -1129,9 +1175,21 @@ never from a raw content-type line — parameters carry `name=` and
        */
       role: CanonicalMailboxRole;
       /**
-       * The mailbox appointed to the role. Absent when the role is unfilled — either nothing was detected yet, or the account genuinely has no such folder. When absent on a GET, this is a server-proposed best guess (SPECIAL-USE flag, then the reserved INBOX name, then a weak name hint) rather than a user's persisted choice; it becomes persisted only once the user calls appointFolderRole.
+       * Where `mailboxId` came from. Read this rather than inferring provenance from the shape of the entry: only `Appointed` means a person decided, and only `Appointed` and `Flagged` are evidence strong enough to destroy mail with.
+       */
+      source: FolderAppointmentSource;
+      /**
+       * The mailbox this role resolves to. Absent when resolution names none — `source: None`, or a `Stale` appointment with nothing to fall back to.
        */
       mailboxId?: UUID;
+      /**
+       * The mailbox the user appointed, when the account no longer holds it. Present exactly when `source` is `Stale`; the appointment is kept rather than collected, so the user can repair it instead of silently losing the choice.
+       */
+      staleAppointmentMailboxId?: UUID;
+      /**
+       * The path that stale mailbox last had, recorded beside the appointment when it was made. Display only — resolution never reads it — and present only alongside `staleAppointmentMailboxId`, and only for an appointment made after the path was first recorded.
+       */
+      staleAppointmentPath?: String512;
     }
     /**
      * The self-update resource: the running version, the outcome of the most recent manifest check, and the state of the current or last run. One read serves every interface state. The check block and the run block are independent by construction (RFC 037 D7).
@@ -4793,6 +4851,7 @@ declare namespace Paths {
     export type RequestBody = Components.Schemas.AppointFolderRoleInput;
     namespace Responses {
       export type $200 = void;
+      export type $409 = void;
     }
   }
   namespace ListFilters {
@@ -4922,6 +4981,7 @@ declare namespace Paths {
     }
     namespace Responses {
       export type $200 = void;
+      export type $409 = void;
     }
   }
   namespace TriggerSync {
@@ -5179,6 +5239,7 @@ declare namespace Paths {
     export type RequestBody = Components.Schemas.DeleteMessagesInput;
     namespace Responses {
       export type $200 = void;
+      export type $409 = void;
     }
   }
   namespace MoveMessages {
@@ -6344,6 +6405,8 @@ export type ValidationError = Components.Schemas.ValidationError;
 export type ApiError = Components.Schemas.ApiError;
 export type AccessPattern = Components.Schemas.AccessPattern;
 export type ResultList = Components.Schemas.ResultList;
+export type FolderRoleConflict = Components.Schemas.FolderRoleConflict;
+export type AppointFolderRoleConflict = Components.Schemas.AppointFolderRoleConflict;
 export type AmazonApiGatewayIntegration = Components.Schemas.AmazonApiGatewayIntegration;
 export type NotFoundError = Components.Schemas.NotFoundError;
 export type InternalServerError = Components.Schemas.InternalServerError;
@@ -6490,6 +6553,7 @@ export type AccountConfigState = Components.Schemas.AccountConfigState;
 export type AccountAuthType = Components.Schemas.AccountAuthType;
 export type ConnectionState = Components.Schemas.ConnectionState;
 export type SyncPhase = Components.Schemas.SyncPhase;
+export type FolderAppointmentSource = Components.Schemas.FolderAppointmentSource;
 export type SystemUpdateCheckStatus = Components.Schemas.SystemUpdateCheckStatus;
 export type SystemUpdatePhase = Components.Schemas.SystemUpdatePhase;
 export type SystemUpdateOutcome = Components.Schemas.SystemUpdateOutcome;