@remit/api-http-client 0.0.20 → 0.0.21

package/package.json

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

package/types.gen.ts

@@ -2161,10 +2161,10 @@ export type RemitImapThreadMessageResponse = {
 
 /**
  * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
- * pagination `continuationToken`, and an optional `count` of matches within the
- * server-capped window. `items` is omitted when `results=false` (count-only);
- * `count` is present only when `count=true`. Thread-specific so the shared
- * `ResultList<T>` (7 endpoints) stays untouched.
+ * pagination `continuationToken`, and an optional `count` of every message the
+ * query matches. `items` is omitted when `results=false` (count-only); `count` is
+ * present only when `count=true`. Thread-specific so the shared `ResultList<T>`
+ * (7 endpoints) stays untouched.
  */
 export type RemitImapThreadSearchResponse = {
     /**
@@ -2176,7 +2176,7 @@ export type RemitImapThreadSearchResponse = {
      */
     continuationToken?: String800;
     /**
-     * Number of matches within the server-capped window. Present only when `count=true`.
+     * How many messages the query matches, over the whole mailbox and independent of `limit`. Present only when `count=true`. With `senderTrust` or `dkimMismatch` in the query the count is over the enriched window instead, since those are resolved off the row.
      */
     count?: number;
 };
@@ -2763,10 +2763,10 @@ export type RemitImapThreadMessageResponseWritable = {
 
 /**
  * Aggregate response for `searchThreads`. Carries the matching rows (`items`), a
- * pagination `continuationToken`, and an optional `count` of matches within the
- * server-capped window. `items` is omitted when `results=false` (count-only);
- * `count` is present only when `count=true`. Thread-specific so the shared
- * `ResultList<T>` (7 endpoints) stays untouched.
+ * pagination `continuationToken`, and an optional `count` of every message the
+ * query matches. `items` is omitted when `results=false` (count-only); `count` is
+ * present only when `count=true`. Thread-specific so the shared `ResultList<T>`
+ * (7 endpoints) stays untouched.
  */
 export type RemitImapThreadSearchResponseWritable = {
     /**
@@ -2778,7 +2778,7 @@ export type RemitImapThreadSearchResponseWritable = {
      */
     continuationToken?: String800;
     /**
-     * Number of matches within the server-capped window. Present only when `count=true`.
+     * How many messages the query matches, over the whole mailbox and independent of `limit`. Present only when `count=true`. With `senderTrust` or `dkimMismatch` in the query the count is over the enriched window instead, since those are resolved off the row.
      */
     count?: number;
 };
@@ -3422,7 +3422,7 @@ export type ThreadOperationsSearchThreadsData = {
          */
         dkimMismatch?: boolean;
         /**
-         * Include a count of matches within the server-capped window.
+         * Include how many messages the query matches. Counted over the whole mailbox, independent of `limit`.
          */
         count?: boolean;
         /**
@@ -3430,7 +3430,7 @@ export type ThreadOperationsSearchThreadsData = {
          */
         results?: boolean;
         /**
-         * Caller-set recency window, capped server-side at 500. Bounds the read.
+         * Page size for the rows returned, capped server-side at 500. Bounds the read, not the `count`.
          */
         limit?: number;
     };