@remit/api-openapi-types 0.0.1 → 0.0.3

package/package.json

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

package/types.d.ts

@@ -184,6 +184,7 @@ current enum emitter anyway, so the wire contract uses the bare form.
     export type UUID = string;
     export type String800 = string;
     export type String512 = string;
+    export type String32 = string;
     export type String256 = string;
     /**
      * A semantic version string (e.g. "1.10.0"). See https://semver.org.
@@ -202,7 +203,6 @@ a compile-time error rather than a value that silently sorts incorrectly.
     export type String200 = string;
     export type String140 = string;
     export type String64 = string;
-    export type String32 = string;
     export interface CognitoAuthorizer {
       /**
        * API key authentication
@@ -858,9 +858,9 @@ a compile-time error rather than a value that silently sorts incorrectly.
        */
       uidNext: number;
       /**
-       * Highest modification sequence number (CONDSTORE). Used to detect mailbox changes efficiently.
+       * Highest modification sequence number (CONDSTORE, RFC 7162) as decimal digits. A modseq is an unsigned 64-bit integer that exceeds both a signed int64 column and JS Number precision, so it is stored as a string and parsed to BigInt only at the point of comparison.
        */
-      highestModseq: number;
+      highestModseq: String32;
       /**
        * Total message count in mailbox
        */
@@ -3994,6 +3994,7 @@ declare namespace Paths {
       continuationToken?: string;
       order?: Components.Schemas.SortOrder;
       limit?: number;
+      starred?: boolean;
     }
     namespace Responses {
       export type $200 = void;
@@ -4406,7 +4407,9 @@ INBOX scope: results are filtered to each account's top-level INBOX, matched by
 
 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.
    */
   'listAllThreads'(
     parameters?: Parameters<Paths.ListAllThreads.QueryParameters> | null,
@@ -4844,7 +4847,9 @@ INBOX scope: results are filtered to each account's top-level INBOX, matched by
 
 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.
      */
     'get'(
       parameters?: Parameters<Paths.ListAllThreads.QueryParameters> | null,
@@ -5193,10 +5198,10 @@ export type MessageFlagPushState = Components.Schemas.MessageFlagPushState;
 export type UUID = Components.Schemas.UUID;
 export type String800 = Components.Schemas.String800;
 export type String512 = Components.Schemas.String512;
+export type String32 = Components.Schemas.String32;
 export type String256 = Components.Schemas.String256;
 export type SemanticVersion = Components.Schemas.SemanticVersion;
 export type String2048 = Components.Schemas.String2048;
 export type String200 = Components.Schemas.String200;
 export type String140 = Components.Schemas.String140;
 export type String64 = Components.Schemas.String64;
-export type String32 = Components.Schemas.String32;