@remit/api-openapi-spec 0.0.48 → 0.0.50

package/openapi.json

@@ -1367,7 +1367,7 @@
     "/addresses/{addressId}": {
       "patch": {
         "operationId": "AddressDetailOperations_updateAddress",
-        "description": "Update an address (currently: per-sender flags). Pass `flags: { <name>: null }` to remove a flag. Other flags are untouched.",
+        "description": "Update an address (currently: per-sender flags). Pass `flags` to set flags and `clearFlags: [\"<name>\"]` to remove them. Other flags are untouched.",
         "parameters": [
           {
             "name": "addressId",
@@ -4852,6 +4852,20 @@
         },
         "description": "Common metadata for sender-level flags"
       },
+      "RemitImap.AddressFlagKey": {
+        "type": "string",
+        "enum": [
+          "trusted",
+          "blocked",
+          "muted",
+          "vip",
+          "junkOnly",
+          "category",
+          "autoArchive",
+          "unsubscribed"
+        ],
+        "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."
+      },
       "RemitImap.AddressFlags": {
         "type": "object",
         "properties": {
@@ -7390,7 +7404,7 @@
             "$ref": "#/components/schemas/RemitImap.AddressFlagBase"
           }
         ],
-        "description": "Address was only ever seen on mail in a Junk folder: withheld from autocomplete suggestions until the account corresponds with it, flags it, or meets it on live mail. Written by sync and by the boot-time repair; clear it by patching this key to null."
+        "description": "Address was only ever seen on mail in a Junk folder: withheld from autocomplete suggestions until the account corresponds with it, flags it, or meets it on live mail. Written by sync and by the boot-time repair; clear it by naming this key in `UpdateAddressInput.clearFlags`."
       },
       "RemitImap.JunkOnlyFlagUpdate": {
         "type": "object",
@@ -7404,7 +7418,7 @@
             "$ref": "#/components/schemas/RemitImap.AddressFlagBaseUpdate"
           }
         ],
-        "description": "Address was only ever seen on mail in a Junk folder: withheld from autocomplete suggestions until the account corresponds with it, flags it, or meets it on live mail. Written by sync and by the boot-time repair; clear it by patching this key to null."
+        "description": "Address was only ever seen on mail in a Junk folder: withheld from autocomplete suggestions until the account corresponds with it, flags it, or meets it on live mail. Written by sync and by the boot-time repair; clear it by naming this key in `UpdateAddressInput.clearFlags`."
       },
       "RemitImap.LabelAction": {
         "type": "string",
@@ -7687,7 +7701,8 @@
           "fullPath",
           "phase",
           "messagesTotal",
-          "messagesSynced"
+          "messagesSynced",
+          "highWaterMarkUid"
         ],
         "properties": {
           "mailboxId": {
@@ -7716,6 +7731,11 @@
             "format": "int32",
             "description": "Approximate number of messages synced. Computed as highWaterMarkUid − lastSyncUid (UID-range approximation; UIDs are sparse so this may undercount). Clamped to messagesTotal."
           },
+          "highWaterMarkUid": {
+            "type": "integer",
+            "format": "int64",
+            "description": "The highest UID ever seen in this mailbox. An arrival is a UID above the highest one seen; a total is not, because one message in and one out nets to zero. A mailbox that has never synced carries the sentinel 0 rather than an absent field."
+          },
           "lastSyncedAt": {
             "type": "integer",
             "format": "int64",
@@ -10013,7 +10033,7 @@
               }
             ],
             "nullable": true,
-            "description": "Set to `null` to offer this address in autocomplete again"
+            "description": "Name this key in `clearFlags` to offer the address in autocomplete again"
           },
           "category": {
             "type": "object",
@@ -10043,7 +10063,7 @@
             "nullable": true
           }
         },
-        "description": "Patch payload for a single AddressFlags entry. Pass `null` for a flag key to remove that flag while leaving the others untouched."
+        "description": "Patch payload for AddressFlags entries. Sets the flags named here and leaves the others untouched. Removal travels in `UpdateAddressInput.clearFlags`, not here: the `null` alternative below is unreachable over OAS 3.0, where a nullable `$ref` emits as `allOf` and the request validator drops the `nullable` — and no `null` form exists at all for `category`, whose value is an enum with no false-equivalent member."
       },
       "RemitImap.UpdateAddressInput": {
         "type": "object",
@@ -10054,7 +10074,14 @@
                 "$ref": "#/components/schemas/RemitImap.UpdateAddressFlagsInput"
               }
             ],
-            "description": "Per-flag merge update; omitted flags are untouched, `null` removes the flag"
+            "description": "Per-flag merge update; omitted flags are untouched"
+          },
+          "clearFlags": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RemitImap.AddressFlagKey"
+            },
+            "description": "Flag keys to remove from the sparse map, leaving the rest untouched. This is the removal form for every flag, whatever its value type — clearing `category` reverts the sender to automatic classification. Applied after `flags`, so a key named in both ends up removed. Removing an absent flag succeeds and changes nothing."
           }
         },
         "description": "Input for updating an Address (currently flag updates only)"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-spec",
-  "version": "0.0.48",
+  "version": "0.0.50",
   "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
   "exports": {
     ".": "./openapi.json",