@remit/api-openapi-types 0.0.61 → 0.0.63

package/package.json

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

package/types.d.ts

@@ -61,6 +61,10 @@ writer can reach is a vocabulary that lies about what the field means.
      * Authentication mechanism used by an email account
      */
     export type AccountAuthType = "password" | "oauthMicrosoft";
+    /**
+     * A service an account syncs. `Mail` covers messages, folders and sending; `Calendar` covers a provider calendar read into the calendar store.
+     */
+    export type AccountService = "Mail" | "Calendar";
     /**
      * IMAP connection states per RFC 9051 Section 3
      */
@@ -597,11 +601,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 +620,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
@@ -1210,6 +1234,10 @@ never from a raw content-type line — parameters carry `name=` and
        * Authentication mechanism used by this account
        */
       authType: AccountAuthType;
+      /**
+       * Services this account syncs. Never empty. A password account holds `Mail` alone. Every account written before this field existed holds `#[AccountService.Mail]`.
+       */
+      syncedServices: AccountService[];
       /**
        * Hashed password for authentication (password accounts only)
        */
@@ -1329,6 +1357,10 @@ never from a raw content-type line — parameters carry `name=` and
        * Authentication mechanism used by this account
        */
       authType: AccountAuthType;
+      /**
+       * Services this account syncs. Never empty. A password account holds `Mail` alone. Every account written before this field existed holds `#[AccountService.Mail]`.
+       */
+      syncedServices: AccountService[];
       /**
        * IMAP server hostname or IP address
        */
@@ -3164,6 +3196,10 @@ asking "is this slot free" never has to do the merging itself.
        * Authentication mechanism for this account. Defaults to `password`. Pass `oauthMicrosoft` only via the OAuth connect flow (POST /accounts/oauth/microsoft/start).
        */
       authType?: AccountAuthType;
+      /**
+       * Services this account syncs. Defaults to `#[Mail]`. Refused when empty, and refused for a password account unless it is exactly `#[Mail]`.
+       */
+      syncedServices?: AccountService[];
       /**
        * Account password (will be encrypted). Required for password accounts; omit for OAuth accounts.
        */
@@ -3351,6 +3387,10 @@ asking "is this slot free" never has to do the merging itself.
        * Enable/disable account
        */
       isActive?: boolean;
+      /**
+       * Replaces the stored service set outright. Refused when empty, on a password account unless it is exactly `#[Mail]`, or when it names a service the account's OAuth grant does not cover. That last case is a consent round trip through the OAuth start route.
+       */
+      syncedServices?: AccountService[];
       /**
        * Plain text email signature
        */
@@ -6399,6 +6439,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;
@@ -6413,6 +6455,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;
@@ -6440,6 +6483,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;
@@ -6464,6 +6508,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;
@@ -7106,6 +7151,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;
@@ -7116,6 +7162,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;
@@ -7320,7 +7367,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,
@@ -8106,7 +8153,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,
@@ -8874,6 +8921,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;
@@ -9052,6 +9100,7 @@ export type QuarantineFailureStage = Components.Schemas.QuarantineFailureStage;
 export type QuarantineFailureCode = Components.Schemas.QuarantineFailureCode;
 export type AccountConfigState = Components.Schemas.AccountConfigState;
 export type AccountAuthType = Components.Schemas.AccountAuthType;
+export type AccountService = Components.Schemas.AccountService;
 export type ConnectionState = Components.Schemas.ConnectionState;
 export type SyncPhase = Components.Schemas.SyncPhase;
 export type FolderAppointmentSource = Components.Schemas.FolderAppointmentSource;