@remit/api-openapi-spec 0.0.55 → 0.0.57

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/openapi.json +67 -1
  2. package/package.json +1 -1
package/openapi.json CHANGED
@@ -1453,6 +1453,7 @@
1453
1453
  },
1454
1454
  "patch": {
1455
1455
  "operationId": "MailboxDetailOperations_renameMailbox",
1456
+ "description": "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.",
1456
1457
  "parameters": [
1457
1458
  {
1458
1459
  "name": "accountId",
@@ -1482,6 +1483,16 @@
1482
1483
  }
1483
1484
  }
1484
1485
  },
1486
+ "400": {
1487
+ "description": "The request was refused as malformed or contradictory. `code` is\n`invalid_request` where nothing more specific is known, and the refusal's own\ntoken where there is one.\n\nThe calendar surface answers with the reason it read the request by:\n`invalid_window`, `invalid_scope`, `invalid_url_segment`, `url_segment_taken`,\n`unknown_time_zone` and `default_calendar_undeletable` on the collection and\nthe query, and, for a VCALENDAR it could not accept,\n`malformed_icalendar`, `not_a_calendar`, `unsupported_component`, `no_event`,\n`no_master_event`, `multiple_master_events`, `missing_uid`, `mismatched_uid`,\n`missing_dt_start`, `backwards_end`, `invalid_date_time`,\n`invalid_recurrence_rule`, `missing_recurrence_id`, `not_recurring` and\n`unknown_occurrence`.\n\n`errors` is present only when the request failed schema validation before any\nhandler ran, and names every field that was refused.",
1488
+ "content": {
1489
+ "application/json": {
1490
+ "schema": {
1491
+ "$ref": "#/components/schemas/ValidationError"
1492
+ }
1493
+ }
1494
+ }
1495
+ },
1485
1496
  "401": {
1486
1497
  "description": "The request carried no usable credential. `code` is `unauthorized`.",
1487
1498
  "content": {
@@ -1511,6 +1522,16 @@
1511
1522
  }
1512
1523
  }
1513
1524
  }
1525
+ },
1526
+ "409": {
1527
+ "description": "The request contradicts the state the resource is in. `code` is `conflict`\nunless the refusal names its own — see `FolderRoleConflict`,\n`MessagePlacementConflict` and `ConfigImportConflict`.",
1528
+ "content": {
1529
+ "application/json": {
1530
+ "schema": {
1531
+ "$ref": "#/components/schemas/ApiError"
1532
+ }
1533
+ }
1534
+ }
1514
1535
  }
1515
1536
  },
1516
1537
  "requestBody": {
@@ -6600,7 +6621,8 @@
6600
6621
  "junkOnly",
6601
6622
  "category",
6602
6623
  "autoArchive",
6603
- "unsubscribed"
6624
+ "unsubscribed",
6625
+ "neverSpam"
6604
6626
  ],
6605
6627
  "description": "Names a key of `AddressFlags` that a client may address in `PATCH /addresses/{addressId}`. `wellknown` is deliberately absent: it is server-owned, derived from engagement counters, and is never written or removed by a client."
6606
6628
  },
@@ -6613,6 +6635,9 @@
6613
6635
  "blocked": {
6614
6636
  "$ref": "#/components/schemas/RemitImap.BlockedFlag"
6615
6637
  },
6638
+ "neverSpam": {
6639
+ "$ref": "#/components/schemas/RemitImap.NeverSpamFlag"
6640
+ },
6616
6641
  "muted": {
6617
6642
  "$ref": "#/components/schemas/RemitImap.MutedFlag"
6618
6643
  },
@@ -9967,6 +9992,37 @@
9967
9992
  ],
9968
9993
  "description": "IMAP namespace types per RFC 9051 Section 6.3.10"
9969
9994
  },
9995
+ "RemitImap.NeverSpamFlag": {
9996
+ "type": "object",
9997
+ "required": [
9998
+ "value"
9999
+ ],
10000
+ "properties": {
10001
+ "value": {
10002
+ "type": "boolean"
10003
+ }
10004
+ },
10005
+ "allOf": [
10006
+ {
10007
+ "$ref": "#/components/schemas/RemitImap.AddressFlagBase"
10008
+ }
10009
+ ],
10010
+ "description": "Sender is never spam: their mail is rescued from Junk whatever the authentication signals say. Mutually exclusive with `blocked` — the flag written last removes the other."
10011
+ },
10012
+ "RemitImap.NeverSpamFlagUpdate": {
10013
+ "type": "object",
10014
+ "properties": {
10015
+ "value": {
10016
+ "type": "boolean"
10017
+ }
10018
+ },
10019
+ "allOf": [
10020
+ {
10021
+ "$ref": "#/components/schemas/RemitImap.AddressFlagBaseUpdate"
10022
+ }
10023
+ ],
10024
+ "description": "Sender is never spam: their mail is rescued from Junk whatever the authentication signals say. Mutually exclusive with `blocked` — the flag written last removes the other."
10025
+ },
9970
10026
  "RemitImap.OrganizeInput": {
9971
10027
  "type": "object",
9972
10028
  "required": [
@@ -11756,6 +11812,16 @@
11756
11812
  ],
11757
11813
  "nullable": true
11758
11814
  },
11815
+ "neverSpam": {
11816
+ "type": "object",
11817
+ "allOf": [
11818
+ {
11819
+ "$ref": "#/components/schemas/RemitImap.NeverSpamFlagUpdate"
11820
+ }
11821
+ ],
11822
+ "nullable": true,
11823
+ "description": "Setting this to `value: true` removes `blocked`, and setting `blocked` removes this one; the two cannot both stand"
11824
+ },
11759
11825
  "muted": {
11760
11826
  "type": "object",
11761
11827
  "allOf": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-spec",
3
- "version": "0.0.55",
3
+ "version": "0.0.57",
4
4
  "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
5
5
  "exports": {
6
6
  ".": "./openapi.json",