@remit/api-http-client 0.0.43 → 0.0.44

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-http-client",
-  "version": "0.0.43",
+  "version": "0.0.44",
   "type": "module",
   "exports": {
     ".": "./index.ts",

package/types.gen.ts

@@ -3072,18 +3072,23 @@ export type RemitImapThreadSearchResponse = {
      */
     continuationToken?: String800;
     /**
-     * How much the query matches, over the whole scope and independent of `limit`.
-     * Present only when `count=true`.
+     * How much the query matches, over the whole scope. Exact: no page size bounds
+     * it, no cursor narrows it, so it is the same number on the first page and the
+     * last. Present only when `count=true`.
      *
      * Each operation counts what it lists. `searchThreads` lists messages of one
-     * mailbox and counts messages; with `senderTrust` or `dkimMismatch` in the
-     * query that count is over the enriched window instead, since those are
-     * resolved off the row. `listAllThreads` counts CONVERSATIONS across every
-     * non-muted mailbox of every account — a thread holding two matching messages
-     * counts once, and so does one message reachable through a real folder and a
-     * virtual copy of it — because that is what the cross-account listing renders
-     * after collapsing by `threadId`. A count that disagreed with the rows beneath
-     * it would be a third number for the same set.
+     * mailbox and counts messages. `listAllThreads` counts CONVERSATIONS across
+     * every non-muted mailbox of every account — a thread holding two matching
+     * messages counts once, and so does one message reachable through a real
+     * folder and a virtual copy of it — because that is what the cross-account
+     * listing renders after collapsing by `threadId`. A count that disagreed with
+     * the rows beneath it would be a third number for the same set.
+     *
+     * Absent when the query carries `senderTrust` or `dkimMismatch`, even with
+     * `count=true`. Those are resolved by enriching rows rather than by a
+     * predicate, so no exact count exists short of enriching the whole mailbox.
+     * Absence says so; a page's post-filter length labelled `count` would be a
+     * page length presented as a total. A client with no number renders none.
      */
     count?: number;
 };
@@ -3810,18 +3815,23 @@ export type RemitImapThreadSearchResponseWritable = {
      */
     continuationToken?: String800;
     /**
-     * How much the query matches, over the whole scope and independent of `limit`.
-     * Present only when `count=true`.
+     * How much the query matches, over the whole scope. Exact: no page size bounds
+     * it, no cursor narrows it, so it is the same number on the first page and the
+     * last. Present only when `count=true`.
      *
      * Each operation counts what it lists. `searchThreads` lists messages of one
-     * mailbox and counts messages; with `senderTrust` or `dkimMismatch` in the
-     * query that count is over the enriched window instead, since those are
-     * resolved off the row. `listAllThreads` counts CONVERSATIONS across every
-     * non-muted mailbox of every account — a thread holding two matching messages
-     * counts once, and so does one message reachable through a real folder and a
-     * virtual copy of it — because that is what the cross-account listing renders
-     * after collapsing by `threadId`. A count that disagreed with the rows beneath
-     * it would be a third number for the same set.
+     * mailbox and counts messages. `listAllThreads` counts CONVERSATIONS across
+     * every non-muted mailbox of every account — a thread holding two matching
+     * messages counts once, and so does one message reachable through a real
+     * folder and a virtual copy of it — because that is what the cross-account
+     * listing renders after collapsing by `threadId`. A count that disagreed with
+     * the rows beneath it would be a third number for the same set.
+     *
+     * Absent when the query carries `senderTrust` or `dkimMismatch`, even with
+     * `count=true`. Those are resolved by enriching rows rather than by a
+     * predicate, so no exact count exists short of enriching the whole mailbox.
+     * Absence says so; a page's post-filter length labelled `count` would be a
+     * page length presented as a total. A client with no number renders none.
      */
     count?: number;
 };
@@ -5178,7 +5188,7 @@ export type ThreadOperationsSearchThreadsData = {
         starred?: boolean;
         attachments?: boolean;
         /**
-         * Filter to messages whose From address has one of these trust levels. Off-row criterion, resolved by in-handler enrichment over the capped window.
+         * Filter to messages whose From address has one of these trust levels. Off-row criterion: resolved by enriching the rows this page read, not by a predicate over the mailbox, so `count` comes back absent whenever it is supplied.
          */
         senderTrust?: Array<RemitImapSenderTrust>;
         /**
@@ -5186,11 +5196,11 @@ export type ThreadOperationsSearchThreadsData = {
          */
         category?: Array<RemitImapMessageCategory>;
         /**
-         * Filter on the DKIM-alignment signal (true = DKIM mismatch). Off-row criterion; rows without an authenticity signal never match.
+         * Filter on the DKIM-alignment signal (true = DKIM mismatch). Off-row criterion, like `senderTrust`: rows without an authenticity signal never match, and `count` comes back absent whenever it is supplied.
          */
         dkimMismatch?: boolean;
         /**
-         * Include how many messages the query matches. Counted over the whole mailbox, independent of `limit`.
+         * Include how many messages the query matches, exactly, over the whole mailbox. Opt-in because it is a second read over the entire match set rather than a by-product of the page: ask for it on a deliberate act, never on a keystroke. Answered as absent — not as a page length — when the query carries `senderTrust` or `dkimMismatch`, which no predicate can count.
          */
         count?: boolean;
         /**
@@ -5198,7 +5208,7 @@ export type ThreadOperationsSearchThreadsData = {
          */
         results?: boolean;
         /**
-         * Page size for the rows returned, capped server-side at 500. Bounds the read, not the `count`.
+         * Page size for the rows returned, capped server-side at 500. It bounds this page and nothing else: `count` is over the whole mailbox and does not move when this does.
          */
         limit?: number;
     };
@@ -5824,7 +5834,7 @@ export type UnifiedThreadOperationsListAllThreadsData = {
          */
         attachments?: boolean;
         /**
-         * Include how many messages the listing matches. Counted over the whole scope, independent of `limit`.
+         * Include how many conversations the listing matches, exactly, over the whole scope. Opt-in because it is a second read over the entire match set rather than a by-product of the page: ask for it on a deliberate act, never on a keystroke.
          */
         count?: boolean;
         /**