@remit/api-openapi-types 0.0.62 → 0.0.64

package/package.json

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

package/types.d.ts

@@ -61,6 +61,10 @@ writer can reach is a vocabulary that lies about what the field means.
      * Authentication mechanism used by an email account
      */
     export type AccountAuthType = "password" | "oauthMicrosoft";
+    /**
+     * A service an account syncs. `Mail` covers messages, folders and sending; `Calendar` covers a provider calendar read into the calendar store.
+     */
+    export type AccountService = "Mail" | "Calendar";
     /**
      * IMAP connection states per RFC 9051 Section 3
      */
@@ -1230,6 +1234,10 @@ never from a raw content-type line — parameters carry `name=` and
        * Authentication mechanism used by this account
        */
       authType: AccountAuthType;
+      /**
+       * Services this account syncs. Never empty. A password account holds `Mail` alone. Every account written before this field existed holds `#[AccountService.Mail]`.
+       */
+      syncedServices: AccountService[];
       /**
        * Hashed password for authentication (password accounts only)
        */
@@ -1349,6 +1357,10 @@ never from a raw content-type line — parameters carry `name=` and
        * Authentication mechanism used by this account
        */
       authType: AccountAuthType;
+      /**
+       * Services this account syncs. Never empty. A password account holds `Mail` alone. Every account written before this field existed holds `#[AccountService.Mail]`.
+       */
+      syncedServices: AccountService[];
       /**
        * IMAP server hostname or IP address
        */
@@ -3184,6 +3196,10 @@ asking "is this slot free" never has to do the merging itself.
        * Authentication mechanism for this account. Defaults to `password`. Pass `oauthMicrosoft` only via the OAuth connect flow (POST /accounts/oauth/microsoft/start).
        */
       authType?: AccountAuthType;
+      /**
+       * Services this account syncs. Defaults to `#[Mail]`. Refused when empty, and refused for a password account unless it is exactly `#[Mail]`.
+       */
+      syncedServices?: AccountService[];
       /**
        * Account password (will be encrypted). Required for password accounts; omit for OAuth accounts.
        */
@@ -3371,6 +3387,10 @@ asking "is this slot free" never has to do the merging itself.
        * Enable/disable account
        */
       isActive?: boolean;
+      /**
+       * Replaces the stored service set outright. Refused when empty, on a password account unless it is exactly `#[Mail]`, or when it names a service the account's OAuth grant does not cover. That last case is a consent round trip through the OAuth start route.
+       */
+      syncedServices?: AccountService[];
       /**
        * Plain text email signature
        */
@@ -7716,7 +7736,7 @@ Ordering: oldest first, by the date the message was sent, with `threadMessageId`
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ListThreadMessages.Responses.$200>;
   /**
-   * listAllThreads - List threads across all non-muted accounts of the caller, ordered by sentDate desc. Each row carries an attached `accountId` (derived from a mailboxId→accountId map at read time) plus the usual `senderTrust` enrichment; `category` is served from the ThreadMessage row. Served by the `byDate` LSI1 (pk = the caller's account config), so the caller can never see another account config's threads.
+   * listAllThreads - List threads across all non-muted accounts of the caller, ordered by sentDate desc (search mode ranks sender matches first, see below). Each row carries an attached `accountId` (derived from a mailboxId→accountId map at read time) plus the usual `senderTrust` enrichment; `category` is served from the ThreadMessage row. Served by the `byDate` LSI1 (pk = the caller's account config), so the caller can never see another account config's threads.
 
 INBOX scope: results are filtered to each account's top-level INBOX, matched by exact path `fullPath === "INBOX"` (RFC 6154 defines no Inbox special-use). By design this excludes namespaced sub-paths like `INBOX/Receipts` and non-English server primaries — the unified inbox is each account's primary INBOX, not its sub-folders. Soft-deleted rows are also excluded.
 
@@ -7726,7 +7746,7 @@ 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, 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.
+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 does not stem. Rows come in two tiers: a row whose From matches any term ranks above a row that only mentions the terms in its subject or body text, and each tier runs in date order.
 
 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.
 
@@ -8552,7 +8572,7 @@ Ordering: oldest first, by the date the message was sent, with `threadMessageId`
   };
   ['/threads']: {
     /**
-     * listAllThreads - List threads across all non-muted accounts of the caller, ordered by sentDate desc. Each row carries an attached `accountId` (derived from a mailboxId→accountId map at read time) plus the usual `senderTrust` enrichment; `category` is served from the ThreadMessage row. Served by the `byDate` LSI1 (pk = the caller's account config), so the caller can never see another account config's threads.
+     * listAllThreads - List threads across all non-muted accounts of the caller, ordered by sentDate desc (search mode ranks sender matches first, see below). Each row carries an attached `accountId` (derived from a mailboxId→accountId map at read time) plus the usual `senderTrust` enrichment; `category` is served from the ThreadMessage row. Served by the `byDate` LSI1 (pk = the caller's account config), so the caller can never see another account config's threads.
 
 INBOX scope: results are filtered to each account's top-level INBOX, matched by exact path `fullPath === "INBOX"` (RFC 6154 defines no Inbox special-use). By design this excludes namespaced sub-paths like `INBOX/Receipts` and non-English server primaries — the unified inbox is each account's primary INBOX, not its sub-folders. Soft-deleted rows are also excluded.
 
@@ -8562,7 +8582,7 @@ 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, 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.
+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 does not stem. Rows come in two tiers: a row whose From matches any term ranks above a row that only mentions the terms in its subject or body text, and each tier runs in date order.
 
 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.
 
@@ -9080,6 +9100,7 @@ export type QuarantineFailureStage = Components.Schemas.QuarantineFailureStage;
 export type QuarantineFailureCode = Components.Schemas.QuarantineFailureCode;
 export type AccountConfigState = Components.Schemas.AccountConfigState;
 export type AccountAuthType = Components.Schemas.AccountAuthType;
+export type AccountService = Components.Schemas.AccountService;
 export type ConnectionState = Components.Schemas.ConnectionState;
 export type SyncPhase = Components.Schemas.SyncPhase;
 export type FolderAppointmentSource = Components.Schemas.FolderAppointmentSource;