@remit/api-openapi-types 0.0.53 → 0.0.55

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.53",
+  "version": "0.0.55",
   "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;
@@ -6529,6 +6537,10 @@ declare namespace Paths {
       limit?: number;
       starred?: boolean;
       query?: string;
+      from?: string;
+      subject?: string;
+      accountId?: Components.Schemas.UUID;
+      muted?: boolean;
       category?: Components.Schemas.MessageCategory[];
       unread?: boolean;
       attachments?: boolean;
@@ -7288,7 +7300,9 @@ Pagination: pass the returned `continuationToken` to fetch the next page; keep p
 
 Starred mode (`starred=true`): served by the `byStarred` LSI4 instead. A star is a marker on the mail rather than on its placement, so the INBOX scope does not apply and a starred thread in Archive is still returned. Excluded are muted and soft-deleted rows as usual, plus the folders a star never surfaces from: Junk, Trash, and Gmail's All Mail (a second copy of everything, whose rows would otherwise double every starred message). All filtering happens in the query, so a page is short only when the results are exhausted. Rows are per mailbox: the same mail filed in two folders is two rows sharing a `threadId`, and a client rendering one row per conversation collapses by `threadId` across the pages it has accumulated.
 
-Search mode (`query=<text>`): the listing widens past the INBOX scope to every non-muted mailbox of every non-muted account, and returns only rows whose subject or From address matches the text. This is the unscoped search of the daily brief: one query reaching every folder of every account. Whitespace splits the text into terms and every term must match (AND), each against subject OR From. Matching is case-insensitive substring, not tokenized full-text, so it neither stems nor ranks.
+Search mode (`query=<text>`): the listing widens past the INBOX scope to every non-muted mailbox of every non-muted account, and returns only rows whose subject, From address or body text matches the text. This is the unscoped search of the daily brief: one query reaching every folder of every account. Whitespace splits the text into terms and every term must match (AND), each against subject OR From OR body. Matching is case-insensitive substring, not tokenized full-text, so it neither stems nor ranks.
+
+Body text is the stored preview the row carries — the first prose of the message with quoted replies removed, which is the same text the row renders under its subject. A term further into a long message is not reached; a term the reader can see on the row is.
 
 Search scope: every non-muted mailbox EXCEPT Trash. The scope is defined by what it excludes, so anything a server offers that is not on that list is searched — Spam, Drafts and Gmail's virtual folders (All Mail, Starred, Important) included. Spam is deliberately in scope: the point of an unscoped search is that it reaches the folders the user did not think to look in. Combining `query` with `starred=true` searches the starred scope instead.
 
@@ -7302,6 +7316,12 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
 
 Row filters: `category`, `unread` and `attachments` are columns on the ThreadMessage row, so each is a predicate inside the query rather than a pass over what a page returned. They compose with every mode above — INBOX, starred and search alike — and a page therefore comes back full of matches however rare the criterion is. This is what the cross-account collections need: filtering the pages a client happens to have loaded shows an empty list whenever the matching mail sits below the newest page (#308).
 
+Field filters: `from` and `subject` each match one field, which the single `query` cannot express — it matches both at once. They compose with `query` and with each other as further AND terms.
+
+Account scope: `accountId` narrows every mode to the mailboxes of one account. The scope is built from the account's own mailboxes, so the listing, the count and the search all answer over the same set. Without it the listing is the cross-account aggregate.
+
+Muted senders: `muted=false` excludes rows whose From address is muted, `muted=true` returns only those, and omitting it filters nothing. Muting is a property of the address rather than a column on the row, so this is the one predicate that reaches outside the ThreadMessage table; it applies to the listing and the `count` alike, which is what lets a caller that hides muted mail state a number that is the size of what it renders.
+
 Counting: `count=true` answers how many CONVERSATIONS match, over the whole scope and independent of `limit`. `results=false` omits the rows, which is how a header total is read without also paying for a page of mail. Conversations rather than rows because that is what this listing renders: a row is per mailbox, so the same mail filed in two folders is two rows sharing a `threadId`, and clients collapse by it. Counting rows would put a third number beside a list that shows a second one.
    */
   'listAllThreads'(
@@ -7406,7 +7426,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,
@@ -8114,7 +8134,9 @@ Pagination: pass the returned `continuationToken` to fetch the next page; keep p
 
 Starred mode (`starred=true`): served by the `byStarred` LSI4 instead. A star is a marker on the mail rather than on its placement, so the INBOX scope does not apply and a starred thread in Archive is still returned. Excluded are muted and soft-deleted rows as usual, plus the folders a star never surfaces from: Junk, Trash, and Gmail's All Mail (a second copy of everything, whose rows would otherwise double every starred message). All filtering happens in the query, so a page is short only when the results are exhausted. Rows are per mailbox: the same mail filed in two folders is two rows sharing a `threadId`, and a client rendering one row per conversation collapses by `threadId` across the pages it has accumulated.
 
-Search mode (`query=<text>`): the listing widens past the INBOX scope to every non-muted mailbox of every non-muted account, and returns only rows whose subject or From address matches the text. This is the unscoped search of the daily brief: one query reaching every folder of every account. Whitespace splits the text into terms and every term must match (AND), each against subject OR From. Matching is case-insensitive substring, not tokenized full-text, so it neither stems nor ranks.
+Search mode (`query=<text>`): the listing widens past the INBOX scope to every non-muted mailbox of every non-muted account, and returns only rows whose subject, From address or body text matches the text. This is the unscoped search of the daily brief: one query reaching every folder of every account. Whitespace splits the text into terms and every term must match (AND), each against subject OR From OR body. Matching is case-insensitive substring, not tokenized full-text, so it neither stems nor ranks.
+
+Body text is the stored preview the row carries — the first prose of the message with quoted replies removed, which is the same text the row renders under its subject. A term further into a long message is not reached; a term the reader can see on the row is.
 
 Search scope: every non-muted mailbox EXCEPT Trash. The scope is defined by what it excludes, so anything a server offers that is not on that list is searched — Spam, Drafts and Gmail's virtual folders (All Mail, Starred, Important) included. Spam is deliberately in scope: the point of an unscoped search is that it reaches the folders the user did not think to look in. Combining `query` with `starred=true` searches the starred scope instead.
 
@@ -8128,6 +8150,12 @@ Callers that omit `query` are unaffected: the INBOX (and starred) listings behav
 
 Row filters: `category`, `unread` and `attachments` are columns on the ThreadMessage row, so each is a predicate inside the query rather than a pass over what a page returned. They compose with every mode above — INBOX, starred and search alike — and a page therefore comes back full of matches however rare the criterion is. This is what the cross-account collections need: filtering the pages a client happens to have loaded shows an empty list whenever the matching mail sits below the newest page (#308).
 
+Field filters: `from` and `subject` each match one field, which the single `query` cannot express — it matches both at once. They compose with `query` and with each other as further AND terms.
+
+Account scope: `accountId` narrows every mode to the mailboxes of one account. The scope is built from the account's own mailboxes, so the listing, the count and the search all answer over the same set. Without it the listing is the cross-account aggregate.
+
+Muted senders: `muted=false` excludes rows whose From address is muted, `muted=true` returns only those, and omitting it filters nothing. Muting is a property of the address rather than a column on the row, so this is the one predicate that reaches outside the ThreadMessage table; it applies to the listing and the `count` alike, which is what lets a caller that hides muted mail state a number that is the size of what it renders.
+
 Counting: `count=true` answers how many CONVERSATIONS match, over the whole scope and independent of `limit`. `results=false` omits the rows, which is how a header total is read without also paying for a page of mail. Conversations rather than rows because that is what this listing renders: a row is per mailbox, so the same mail filed in two folders is two rows sharing a `threadId`, and clients collapse by it. Counting rows would put a third number beside a list that shows a second one.
      */
     'get'(
@@ -8252,7 +8280,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 +8682,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;