@remit/api-openapi-types 0.0.37 → 0.0.39

package/package.json

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

package/types.d.ts

@@ -375,6 +375,48 @@ a compile-time error rather than a value that silently sorts incorrectly.
        */
       details?: Record;
     }
+    /**
+     * The same flat 409 body, with the two codes this endpoint can answer with.
+
+`code: "folder_role_unresolved"` — as everywhere else, with `details` carrying `role`, `accountId` and `reason`.
+
+`code: "message_placement_unsettled"` — as `MessagePlacementConflict`, with `details` carrying `accountId`, `messageId` and `reason`.
+     */
+    export interface DeleteMessagesConflict {
+      statusCode: 409;
+      /**
+       * Error code
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
+    /**
+     * The same flat 409 body, for a message whose folder and uid do not name the same message.
+
+`code: "message_placement_unsettled"` — the message is mid-move, so its row names the destination folder while its uid still belongs to the source; acting on that pair would hit whatever the destination holds at that uid. `details` carries `accountId`, `messageId` and `reason`, one of: `in_flight` (the move is still running, and the same request succeeds once it confirms) or `unverified` (the move gave up without confirming, so where the message sits is unknown until the folder is resynced).
+     */
+    export interface MessagePlacementConflict {
+      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";
@@ -1191,6 +1233,19 @@ never from a raw content-type line — parameters carry `name=` and
        */
       staleAppointmentPath?: String512;
     }
+    /**
+     * A configuration export: one versioned document carrying every user decision this instance holds, and no credential.
+     */
+    export interface ConfigExportResponse {
+      /**
+       * Schema version of the document below
+       */
+      schemaVersion: number;
+      /**
+       * The config document. Opaque here; the JSON Schema for `schemaVersion` is its contract.
+       */
+      document: Record;
+    }
     /**
      * 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).
      */
@@ -4789,6 +4844,11 @@ declare namespace Paths {
       export type $200 = void;
     }
   }
+  namespace ExportConfig {
+    namespace Responses {
+      export type $200 = void;
+    }
+  }
   namespace GetSystemUpdate {
     export interface QueryParameters {
       refresh?: boolean;
@@ -5262,6 +5322,7 @@ declare namespace Paths {
     export type RequestBody = Components.Schemas.CopyMessagesInput;
     namespace Responses {
       export type $200 = void;
+      export type $409 = void;
     }
   }
   namespace UpdateMessageLabels {
@@ -5333,6 +5394,14 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.GetConfig.Responses.$200>;
+  /**
+   * exportConfig - Export every configured setting for the caller as one versioned JSON document. Contains no credentials: no IMAP/SMTP password and no OAuth token, encrypted or otherwise, and the credential fields are structurally absent rather than blank. The document's own shape is not defined here - it is defined by the published JSON Schema for its `schemaVersion` (build/config-schema/reader-config.v<N>.schema.json), so a file keeps validating independent of this API's models.
+   */
+  'exportConfig'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.ExportConfig.Responses.$200>;
   /**
    * getSystemUpdate - Read the self-update resource: the running version, the outcome of the most recent manifest check, and the state of the current or last run. With `refresh=true`, records a check request on the control volume for the updater to pick up and answers with the stored state as it stands; the caller watches `check.lastCheckedAt` for the updater's answer. Owner-only, and absent (404) unless a manifest URL is configured (RFC 037 D7, D8).
    */
@@ -5860,6 +5929,16 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.GetConfig.Responses.$200>;
   };
+  ['/config/export']: {
+    /**
+     * exportConfig - Export every configured setting for the caller as one versioned JSON document. Contains no credentials: no IMAP/SMTP password and no OAuth token, encrypted or otherwise, and the credential fields are structurally absent rather than blank. The document's own shape is not defined here - it is defined by the published JSON Schema for its `schemaVersion` (build/config-schema/reader-config.v<N>.schema.json), so a file keeps validating independent of this API's models.
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.ExportConfig.Responses.$200>;
+  };
   ['/system/update']: {
     /**
      * getSystemUpdate - Read the self-update resource: the running version, the outcome of the most recent manifest check, and the state of the current or last run. With `refresh=true`, records a check request on the control volume for the updater to pick up and answers with the stored state as it stands; the caller watches `check.lastCheckedAt` for the updater's answer. Owner-only, and absent (404) unless a manifest URL is configured (RFC 037 D7, D8).
@@ -6417,6 +6496,8 @@ 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 DeleteMessagesConflict = Components.Schemas.DeleteMessagesConflict;
+export type MessagePlacementConflict = Components.Schemas.MessagePlacementConflict;
 export type AmazonApiGatewayIntegration = Components.Schemas.AmazonApiGatewayIntegration;
 export type NotFoundError = Components.Schemas.NotFoundError;
 export type InternalServerError = Components.Schemas.InternalServerError;
@@ -6441,6 +6522,7 @@ export type AccountResponse = Components.Schemas.AccountResponse;
 export type AddressFlagBase = Components.Schemas.AddressFlagBase;
 export type MutedFlag = Components.Schemas.MutedFlag;
 export type FolderAppointment = Components.Schemas.FolderAppointment;
+export type ConfigExportResponse = Components.Schemas.ConfigExportResponse;
 export type SystemUpdateResponse = Components.Schemas.SystemUpdateResponse;
 export type SystemUpdateCheck = Components.Schemas.SystemUpdateCheck;
 export type SystemUpdateRun = Components.Schemas.SystemUpdateRun;