@remit/api-http-client 0.0.1 → 0.0.3

package/@tanstack/react-query.gen.ts

@@ -800,7 +800,9 @@ export const unifiedThreadOperationsListAllThreadsQueryKey = (options?: Options<
  *
  * Mute exclusion: muted accounts and muted mailboxes are excluded. The inbox/mute filter set is rebuilt per page from live state, so muting/unmuting a mailbox mid-pagination takes effect on the next page (never retroactively).
  *
- * Pagination: pass the returned `continuationToken` to fetch the next page; keep paging until it is absent. The INBOX/deleted filter is applied after the index read with a bounded read window per request, so a page may return FEWER than `limit` rows while still carrying a `continuationToken` — treat the presence of the token (not a full page) as the "more results" signal. No rows are skipped or duplicated across pages.
+ * Pagination: pass the returned `continuationToken` to fetch the next page; keep paging until it is absent. In the default (INBOX) mode the INBOX/deleted filter is applied after the index read with a bounded read window per request, so a page may return FEWER than `limit` rows while still carrying a `continuationToken` — treat the presence of the token (not a full page) as the "more results" signal. No rows are skipped or duplicated across pages.
+ *
+ * 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.
  */
 export const unifiedThreadOperationsListAllThreadsOptions = (options?: Options<UnifiedThreadOperationsListAllThreadsData>) => queryOptions<UnifiedThreadOperationsListAllThreadsResponse, DefaultError, UnifiedThreadOperationsListAllThreadsResponse, ReturnType<typeof unifiedThreadOperationsListAllThreadsQueryKey>>({
     queryFn: async ({ queryKey, signal }) => {
@@ -818,7 +820,9 @@ export const unifiedThreadOperationsListAllThreadsOptions = (options?: Options<U
 export const threadDetailOperationsListThreadMessagesQueryKey = (options: Options<ThreadDetailOperationsListThreadMessagesData>) => createQueryKey('threadDetailOperationsListThreadMessages', options);
 
 /**
- * Get all messages in a thread. Optionally filter by mailboxId to deduplicate when messages exist in multiple mailboxes.
+ * Get all messages in a thread, across every mailbox of the account — a conversation spans INBOX, Sent, Archive and any folder the user filed a message in, so it is never scoped to one mailbox. Soft-deleted messages (including anything moved to Trash) are excluded.
+ *
+ * One entry per piece of mail. A message synced from several folders is stored once, and where a second row exists for the same Message-ID — a copy taken with `copyMessages`, which gives its copy a fresh message id — the oldest is returned and the rest are dropped.
  */
 export const threadDetailOperationsListThreadMessagesOptions = (options: Options<ThreadDetailOperationsListThreadMessagesData>) => queryOptions<ThreadDetailOperationsListThreadMessagesResponse, DefaultError, ThreadDetailOperationsListThreadMessagesResponse, ReturnType<typeof threadDetailOperationsListThreadMessagesQueryKey>>({
     queryFn: async ({ queryKey, signal }) => {

package/package.json

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

package/sdk.gen.ts

@@ -467,7 +467,9 @@ export const semanticSearchOperationsSemanticSearch = <ThrowOnError extends bool
  *
  * Mute exclusion: muted accounts and muted mailboxes are excluded. The inbox/mute filter set is rebuilt per page from live state, so muting/unmuting a mailbox mid-pagination takes effect on the next page (never retroactively).
  *
- * Pagination: pass the returned `continuationToken` to fetch the next page; keep paging until it is absent. The INBOX/deleted filter is applied after the index read with a bounded read window per request, so a page may return FEWER than `limit` rows while still carrying a `continuationToken` — treat the presence of the token (not a full page) as the "more results" signal. No rows are skipped or duplicated across pages.
+ * Pagination: pass the returned `continuationToken` to fetch the next page; keep paging until it is absent. In the default (INBOX) mode the INBOX/deleted filter is applied after the index read with a bounded read window per request, so a page may return FEWER than `limit` rows while still carrying a `continuationToken` — treat the presence of the token (not a full page) as the "more results" signal. No rows are skipped or duplicated across pages.
+ *
+ * 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.
  */
 export const unifiedThreadOperationsListAllThreads = <ThrowOnError extends boolean = false>(options?: Options<UnifiedThreadOperationsListAllThreadsData, ThrowOnError>) => (options?.client ?? client).get<UnifiedThreadOperationsListAllThreadsResponses, unknown, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
@@ -476,7 +478,9 @@ export const unifiedThreadOperationsListAllThreads = <ThrowOnError extends boole
 });
 
 /**
- * Get all messages in a thread. Optionally filter by mailboxId to deduplicate when messages exist in multiple mailboxes.
+ * Get all messages in a thread, across every mailbox of the account — a conversation spans INBOX, Sent, Archive and any folder the user filed a message in, so it is never scoped to one mailbox. Soft-deleted messages (including anything moved to Trash) are excluded.
+ *
+ * One entry per piece of mail. A message synced from several folders is stored once, and where a second row exists for the same Message-ID — a copy taken with `copyMessages`, which gives its copy a fresh message id — the oldest is returned and the rest are dropped.
  */
 export const threadDetailOperationsListThreadMessages = <ThrowOnError extends boolean = false>(options: Options<ThreadDetailOperationsListThreadMessagesData, ThrowOnError>) => (options.client ?? client).get<ThreadDetailOperationsListThreadMessagesResponses, unknown, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],

package/types.gen.ts

@@ -3201,6 +3201,10 @@ export type UnifiedThreadOperationsListAllThreadsData = {
         continuationToken?: string;
         order?: RemitImapSortOrder;
         limit?: number;
+        /**
+         * When true, return only starred threads — every starred thread in the config, across all non-muted mailboxes, not just the INBOX scope. Starredness is read from `hasStars`, the boolean of record.
+         */
+        starred?: boolean;
     };
     url: '/threads';
 };
@@ -3224,10 +3228,6 @@ export type ThreadDetailOperationsListThreadMessagesData = {
     };
     query?: {
         order?: RemitImapSortOrder;
-        /**
-         * Filter messages to only those in this mailbox (useful for deduplication)
-         */
-        mailboxId?: Uuid;
     };
     url: '/threads/{threadId}/messages';
 };