@remit/api-openapi-types 0.0.53 → 0.0.54

package/package.json

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

package/types.d.ts

@@ -236,6 +236,10 @@ member (naming the file, the size and the cap), so a refusal must be
 distinguishable from a network failure without parsing prose.
      */
     export type OutboxAttachmentRejectionReason = "EmptyFile" | "UnusableFilename" | "FileTooLarge" | "MessageTooLarge" | "TooManyAttachments" | "ReservationExpired" | "UploadMissing" | "SizeMismatch";
+    /**
+     * 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.
+     */
+    export type AddressFlagKey = "trusted" | "blocked" | "muted" | "vip" | "junkOnly" | "category" | "autoArchive" | "unsubscribed";
     /**
      * Whether the header classifier has examined a message's body (issue #331). Persistence-level state on `Message`, deliberately off the wire: no response model carries it. It exists because `category` cannot answer this question — `uncategorized` is both the value a metadata-synced row starts at and the answer the classifier gives when it has nothing to say, so a guard reading `category` alone cannot tell "never examined" from "examined and declined" and re-reads the stored body on every sync pass forever.
      */
@@ -4175,7 +4179,7 @@ either way and cannot tell which it received.
       value: boolean;
     }
     /**
-     * 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.
+     * 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`.
      */
     export interface JunkOnlyFlag {
       /**
@@ -4322,12 +4326,16 @@ either way and cannot tell which it received.
      */
     export interface UpdateAddressInput {
       /**
-       * Per-flag merge update; omitted flags are untouched, `null` removes the flag
+       * Per-flag merge update; omitted flags are untouched
        */
       flags?: UpdateAddressFlagsInput;
+      /**
+       * 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.
+       */
+      clearFlags?: AddressFlagKey[];
     }
     /**
-     * Patch payload for a single AddressFlags entry. Pass `null` for a flag key to remove that flag while leaving the others untouched.
+     * 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.
      */
     export interface UpdateAddressFlagsInput {
       trusted?: TrustedFlag | any;
@@ -4336,7 +4344,7 @@ either way and cannot tell which it received.
       vip?: VipFlag | any;
       wellknown?: WellknownFlag | any;
       /**
-       * Set to `null` to offer this address in autocomplete again
+       * Name this key in `clearFlags` to offer the address in autocomplete again
        */
       junkOnly?: JunkOnlyFlag | any;
       category?: CategoryFlag | any;
@@ -7406,7 +7414,7 @@ Counting: `count=true` answers how many CONVERSATIONS match, over the whole scop
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.SearchAddresses.Responses.$200>;
   /**
-   * updateAddress - Update an address (currently: per-sender flags). Pass `flags: { <name>: null }` to remove a flag. Other flags are untouched.
+   * updateAddress - Update an address (currently: per-sender flags). Pass `flags` to set flags and `clearFlags: ["<name>"]` to remove them. Other flags are untouched.
    */
   'updateAddress'(
     parameters?: Parameters<Paths.UpdateAddress.PathParameters> | null,
@@ -8252,7 +8260,7 @@ Counting: `count=true` answers how many CONVERSATIONS match, over the whole scop
   };
   ['/addresses/{addressId}']: {
     /**
-     * updateAddress - Update an address (currently: per-sender flags). Pass `flags: { <name>: null }` to remove a flag. Other flags are untouched.
+     * updateAddress - Update an address (currently: per-sender flags). Pass `flags` to set flags and `clearFlags: ["<name>"]` to remove them. Other flags are untouched.
      */
     'patch'(
       parameters?: Parameters<Paths.UpdateAddress.PathParameters> | null,
@@ -8654,6 +8662,7 @@ export type SemanticSearchChunkType = Components.Schemas.SemanticSearchChunkType
 export type OutboxMessageStatus = Components.Schemas.OutboxMessageStatus;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
+export type AddressFlagKey = Components.Schemas.AddressFlagKey;
 export type MessageClassificationState = Components.Schemas.MessageClassificationState;
 export type AuthenticityVerdict = Components.Schemas.AuthenticityVerdict;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;