@remit/api-openapi-types 0.0.31 → 0.0.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +66 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-types",
3
- "version": "0.0.31",
3
+ "version": "0.0.33",
4
4
  "type": "module",
5
5
  "main": "types.d.ts",
6
6
  "types": "types.d.ts",
package/types.d.ts CHANGED
@@ -329,6 +329,48 @@ a compile-time error rather than a value that silently sorts incorrectly.
329
329
  continuationToken?: String800;
330
330
  items: any[];
331
331
  }
332
+ /**
333
+ * 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`.
334
+
335
+ `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).
336
+ */
337
+ export interface FolderRoleConflict {
338
+ statusCode: 409;
339
+ /**
340
+ * Error code
341
+ */
342
+ code: string;
343
+ /**
344
+ * Human-readable error message
345
+ */
346
+ message: string;
347
+ /**
348
+ * Additional error details
349
+ */
350
+ details?: Record;
351
+ }
352
+ /**
353
+ * The same flat 409 body as `FolderRoleConflict`, with one code only this endpoint can answer with.
354
+
355
+ `code: "folder_role_unresolved"` — as everywhere else, with `details` carrying `role`, `accountId` and `reason`.
356
+
357
+ `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.
358
+ */
359
+ export interface AppointFolderRoleConflict {
360
+ statusCode: 409;
361
+ /**
362
+ * Error code
363
+ */
364
+ code: string;
365
+ /**
366
+ * Human-readable error message
367
+ */
368
+ message: string;
369
+ /**
370
+ * Additional error details
371
+ */
372
+ details?: Record;
373
+ }
332
374
  export interface AmazonApiGatewayIntegration {
333
375
  type: "aws_proxy";
334
376
  httpMethod: "POST";
@@ -2762,6 +2804,25 @@ present only when `count=true`. Thread-specific so the shared `ResultList<T>`
2762
2804
  * SMTP server's Message-ID response (if different)
2763
2805
  */
2764
2806
  smtpMessageId?: string;
2807
+ /**
2808
+ * Whether the IMAP APPEND that files a copy in Sent has been confirmed, and
2809
+ the uid it produced. Written between the APPEND and the row delete that
2810
+ follows it, so a redelivered APPEND event skips straight to the delete
2811
+ instead of filing a second copy of the same message.
2812
+
2813
+ Three readings, no absent one: the named sentinel `0` means no APPEND has
2814
+ been confirmed for this row. The named sentinel `-1` means an APPEND was
2815
+ confirmed but the server named no uid for it — UIDPLUS is an extension, and
2816
+ a server without it files the copy and reports nothing. Any positive value
2817
+ is the uid the server assigned. Only the latter two mean the copy exists, so
2818
+ a value neither of them reads as unfiled, which re-files at worst rather
2819
+ than dropping the row of a message that reached no folder.
2820
+
2821
+ Deliberately not paired with a uidValidity: this never addresses the
2822
+ message, it only records that the copy exists. Everything that names a
2823
+ message forever (Message, Quarantine) stores both.
2824
+ */
2825
+ appendedUid: number;
2765
2826
  createdAt: number;
2766
2827
  updatedAt: number;
2767
2828
  }
@@ -4774,6 +4835,7 @@ declare namespace Paths {
4774
4835
  export type RequestBody = Components.Schemas.AppointFolderRoleInput;
4775
4836
  namespace Responses {
4776
4837
  export type $200 = void;
4838
+ export type $409 = void;
4777
4839
  }
4778
4840
  }
4779
4841
  namespace ListFilters {
@@ -4903,6 +4965,7 @@ declare namespace Paths {
4903
4965
  }
4904
4966
  namespace Responses {
4905
4967
  export type $200 = void;
4968
+ export type $409 = void;
4906
4969
  }
4907
4970
  }
4908
4971
  namespace TriggerSync {
@@ -5160,6 +5223,7 @@ declare namespace Paths {
5160
5223
  export type RequestBody = Components.Schemas.DeleteMessagesInput;
5161
5224
  namespace Responses {
5162
5225
  export type $200 = void;
5226
+ export type $409 = void;
5163
5227
  }
5164
5228
  }
5165
5229
  namespace MoveMessages {
@@ -6325,6 +6389,8 @@ export type ValidationError = Components.Schemas.ValidationError;
6325
6389
  export type ApiError = Components.Schemas.ApiError;
6326
6390
  export type AccessPattern = Components.Schemas.AccessPattern;
6327
6391
  export type ResultList = Components.Schemas.ResultList;
6392
+ export type FolderRoleConflict = Components.Schemas.FolderRoleConflict;
6393
+ export type AppointFolderRoleConflict = Components.Schemas.AppointFolderRoleConflict;
6328
6394
  export type AmazonApiGatewayIntegration = Components.Schemas.AmazonApiGatewayIntegration;
6329
6395
  export type NotFoundError = Components.Schemas.NotFoundError;
6330
6396
  export type InternalServerError = Components.Schemas.InternalServerError;