@remit/api-openapi-types 0.0.60 → 0.0.62

package/package.json

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

package/types.d.ts

@@ -597,11 +597,9 @@ unless the refusal names its own — see `FolderRoleConflict`,
       details?: Record;
     }
     /**
-     * The same flat 409 body as `FolderRoleConflict`, with one code only this endpoint can answer with.
+     * The same flat 409 body as `FolderRoleConflict`, with the codes 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;
@@ -618,6 +616,28 @@ unless the refusal names its own — see `FolderRoleConflict`,
        */
       details?: Record;
     }
+    /**
+     * The write binds a durable reference — a role appointment, a filter's move target, a message's destination — to a folder whose own mutation has not settled, so the reference would point at something that may never exist.
+
+`code: "mailbox_not_settled"` — `details` carries `mailboxId` and `syncStatus`, one of `pending` (the mail server has not confirmed the folder yet), `deleting` (it is on its way out) or `failed` (its last rename or delete did not land, and the user has a retry or a dismissal to make first). Clearing a reference is never refused this way, and neither is moving mail *out of* such a folder.
+
+422 rather than a second 409: 409 means somebody else is changing this folder right now and the client should refresh, which is different copy and a different remedy.
+     */
+    export interface MailboxNotSettled {
+      statusCode: 422;
+      /**
+       * Stable token naming the refusal. Branch on this, never on `message`.
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
     /**
      * The condition the request stated is no longer true. Answered when an
 `If-Match` names an etag the stored resource no longer carries: somebody else
@@ -6385,6 +6405,8 @@ declare namespace Paths {
     export type RequestBody = Components.Schemas.RenameMailboxInput;
     namespace Responses {
       export type $200 = void;
+      export type $400 = void;
+      export type $409 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -6397,6 +6419,8 @@ declare namespace Paths {
     }
     namespace Responses {
       export type $204 = void;
+      export type $400 = void;
+      export type $409 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -6411,6 +6435,7 @@ declare namespace Paths {
     namespace Responses {
       export type $200 = void;
       export type $409 = void;
+      export type $422 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -6438,6 +6463,7 @@ declare namespace Paths {
     namespace Responses {
       export type $200 = void;
       export type $400 = void;
+      export type $422 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -6462,6 +6488,7 @@ declare namespace Paths {
     export type RequestBody = Components.Schemas.UpdateFilterInput;
     namespace Responses {
       export type $200 = void;
+      export type $422 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -7104,6 +7131,7 @@ declare namespace Paths {
     namespace Responses {
       export type $200 = void;
       export type $409 = void;
+      export type $422 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -7114,6 +7142,7 @@ declare namespace Paths {
     namespace Responses {
       export type $200 = void;
       export type $409 = void;
+      export type $422 = void;
       export type $404 = void;
       export type $403 = void;
       export type $401 = void;
@@ -7310,7 +7339,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetMailbox.Responses.$200>;
   /**
-   * renameMailbox
+   * renameMailbox - Rename a folder, or dismiss a folder mutation that failed. `fullPath` records the rename target over the folder and everything under it; the folder keeps the path the mail server holds until the rename lands. A `fullPath` equal to the folder's current one is a dismissal: it clears a failed rename or delete and enqueues nothing. Refused with 400 for INBOX at either end, a name reserved for a system folder, and a name another folder already has; with 409 when a mutation is already in flight on the folder or on anything inside it.
    */
   'renameMailbox'(
     parameters?: Parameters<Paths.RenameMailbox.PathParameters> | null,
@@ -7318,7 +7347,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.RenameMailbox.Responses.$200>;
   /**
-   * deleteMailbox
+   * deleteMailbox - Record a delete intent for a folder. The folder stays listed, marked as being deleted, until the mail server confirms it and its mail goes with it. Refused with 400 for INBOX, for a folder with folders inside it, and for a folder a filter or a canonical role is bound to — the message names each binding; with 409 when a mutation is already in flight on it.
    */
   'deleteMailbox'(
     parameters?: Parameters<Paths.DeleteMailbox.PathParameters> | null,
@@ -8096,7 +8125,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.GetMailbox.Responses.$200>;
     /**
-     * renameMailbox
+     * renameMailbox - Rename a folder, or dismiss a folder mutation that failed. `fullPath` records the rename target over the folder and everything under it; the folder keeps the path the mail server holds until the rename lands. A `fullPath` equal to the folder's current one is a dismissal: it clears a failed rename or delete and enqueues nothing. Refused with 400 for INBOX at either end, a name reserved for a system folder, and a name another folder already has; with 409 when a mutation is already in flight on the folder or on anything inside it.
      */
     'patch'(
       parameters?: Parameters<Paths.RenameMailbox.PathParameters> | null,
@@ -8104,7 +8133,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.RenameMailbox.Responses.$200>;
     /**
-     * deleteMailbox
+     * deleteMailbox - Record a delete intent for a folder. The folder stays listed, marked as being deleted, until the mail server confirms it and its mail goes with it. Refused with 400 for INBOX, for a folder with folders inside it, and for a folder a filter or a canonical role is bound to — the message names each binding; with 409 when a mutation is already in flight on it.
      */
     'delete'(
       parameters?: Parameters<Paths.DeleteMailbox.PathParameters> | null,
@@ -8872,6 +8901,7 @@ export type ForbiddenError = Components.Schemas.ForbiddenError;
 export type NoContent = Components.Schemas.NoContent;
 export type FolderRoleConflict = Components.Schemas.FolderRoleConflict;
 export type AppointFolderRoleConflict = Components.Schemas.AppointFolderRoleConflict;
+export type MailboxNotSettled = Components.Schemas.MailboxNotSettled;
 export type PreconditionFailedError = Components.Schemas.PreconditionFailedError;
 export type DeleteMessagesConflict = Components.Schemas.DeleteMessagesConflict;
 export type MessagePlacementConflict = Components.Schemas.MessagePlacementConflict;