@remit/api-openapi-types 0.0.32 → 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 +47 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-types",
3
- "version": "0.0.32",
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";
@@ -4793,6 +4835,7 @@ declare namespace Paths {
4793
4835
  export type RequestBody = Components.Schemas.AppointFolderRoleInput;
4794
4836
  namespace Responses {
4795
4837
  export type $200 = void;
4838
+ export type $409 = void;
4796
4839
  }
4797
4840
  }
4798
4841
  namespace ListFilters {
@@ -4922,6 +4965,7 @@ declare namespace Paths {
4922
4965
  }
4923
4966
  namespace Responses {
4924
4967
  export type $200 = void;
4968
+ export type $409 = void;
4925
4969
  }
4926
4970
  }
4927
4971
  namespace TriggerSync {
@@ -5179,6 +5223,7 @@ declare namespace Paths {
5179
5223
  export type RequestBody = Components.Schemas.DeleteMessagesInput;
5180
5224
  namespace Responses {
5181
5225
  export type $200 = void;
5226
+ export type $409 = void;
5182
5227
  }
5183
5228
  }
5184
5229
  namespace MoveMessages {
@@ -6344,6 +6389,8 @@ export type ValidationError = Components.Schemas.ValidationError;
6344
6389
  export type ApiError = Components.Schemas.ApiError;
6345
6390
  export type AccessPattern = Components.Schemas.AccessPattern;
6346
6391
  export type ResultList = Components.Schemas.ResultList;
6392
+ export type FolderRoleConflict = Components.Schemas.FolderRoleConflict;
6393
+ export type AppointFolderRoleConflict = Components.Schemas.AppointFolderRoleConflict;
6347
6394
  export type AmazonApiGatewayIntegration = Components.Schemas.AmazonApiGatewayIntegration;
6348
6395
  export type NotFoundError = Components.Schemas.NotFoundError;
6349
6396
  export type InternalServerError = Components.Schemas.InternalServerError;