@remit/api-http-client 0.0.60 → 0.0.62

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

@@ -321,6 +321,9 @@ export const mailboxOperationsListMailboxesOptions = (options: Options<MailboxOp
     queryKey: mailboxOperationsListMailboxesQueryKey(options)
 });
 
+/**
+ * Create a folder. Refused with 400 when the account already has a folder at that path.
+ */
 export const mailboxOperationsCreateMailboxMutation = (options?: Partial<Options<MailboxOperationsCreateMailboxData>>): UseMutationOptions<MailboxOperationsCreateMailboxResponse, MailboxOperationsCreateMailboxError, Options<MailboxOperationsCreateMailboxData>> => {
     const mutationOptions: UseMutationOptions<MailboxOperationsCreateMailboxResponse, MailboxOperationsCreateMailboxError, Options<MailboxOperationsCreateMailboxData>> = {
         mutationFn: async (fnOptions) => {
@@ -1451,7 +1454,7 @@ export const systemOperationsApplySystemUpdateMutation = (options?: Partial<Opti
 export const unifiedThreadOperationsListAllThreadsQueryKey = (options?: Options<UnifiedThreadOperationsListAllThreadsData>) => createQueryKey('unifiedThreadOperationsListAllThreads', options);
 
 /**
- * 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.
+ * 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.
  *
@@ -1461,7 +1464,7 @@ export const unifiedThreadOperationsListAllThreadsQueryKey = (options?: Options<
  *
  * 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.
  *

package/package.json

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

package/sdk.gen.ts

@@ -182,6 +182,9 @@ export const mailboxOperationsListMailboxes = <ThrowOnError extends boolean = fa
     ...options
 });
 
+/**
+ * Create a folder. Refused with 400 when the account already has a folder at that path.
+ */
 export const mailboxOperationsCreateMailbox = <ThrowOnError extends boolean = false>(options: Options<MailboxOperationsCreateMailboxData, ThrowOnError>): RequestResult<MailboxOperationsCreateMailboxResponses, MailboxOperationsCreateMailboxErrors, ThrowOnError> => (options.client ?? client).post<MailboxOperationsCreateMailboxResponses, MailboxOperationsCreateMailboxErrors, ThrowOnError>({
     security: [{ name: 'Authorization', type: 'apiKey' }],
     url: '/accounts/{accountId}/mailboxes',
@@ -876,7 +879,7 @@ export const systemOperationsApplySystemUpdate = <ThrowOnError extends boolean =
 });
 
 /**
- * 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.
+ * 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.
  *
@@ -886,7 +889,7 @@ export const systemOperationsApplySystemUpdate = <ThrowOnError extends boolean =
  *
  * 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.
  *

package/types.gen.ts

@@ -4763,6 +4763,25 @@ export type MailboxOperationsCreateMailboxData = {
 };
 
 export type MailboxOperationsCreateMailboxErrors = {
+    /**
+     * The request was refused as malformed or contradictory. `code` is
+     * `invalid_request` where nothing more specific is known, and the refusal's own
+     * token where there is one.
+     *
+     * The calendar surface answers with the reason it read the request by:
+     * `invalid_window`, `invalid_scope`, `invalid_url_segment`, `url_segment_taken`,
+     * `unknown_time_zone` and `default_calendar_undeletable` on the collection and
+     * the query, and, for a VCALENDAR it could not accept,
+     * `malformed_icalendar`, `not_a_calendar`, `unsupported_component`, `no_event`,
+     * `no_master_event`, `multiple_master_events`, `missing_uid`, `mismatched_uid`,
+     * `missing_dt_start`, `backwards_end`, `invalid_date_time`,
+     * `invalid_recurrence_rule`, `missing_recurrence_id`, `not_recurring` and
+     * `unknown_occurrence`.
+     *
+     * `errors` is present only when the request failed schema validation before any
+     * handler ran, and names every field that was refused.
+     */
+    400: ValidationError;
     /**
      * The request carried no usable credential. `code` is `unauthorized`.
      */