@remit/api-openapi-types 0.0.63 → 0.0.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types.d.ts +7 -6
package/package.json
CHANGED
package/types.d.ts
CHANGED
|
@@ -6401,6 +6401,7 @@ declare namespace Paths {
|
|
|
6401
6401
|
export type RequestBody = Components.Schemas.CreateMailboxInput;
|
|
6402
6402
|
namespace Responses {
|
|
6403
6403
|
export type $200 = void;
|
|
6404
|
+
export type $400 = void;
|
|
6404
6405
|
export type $404 = void;
|
|
6405
6406
|
export type $403 = void;
|
|
6406
6407
|
export type $401 = void;
|
|
@@ -7343,7 +7344,7 @@ export interface OperationMethods {
|
|
|
7343
7344
|
config?: AxiosRequestConfig
|
|
7344
7345
|
): OperationResponse<Paths.ListMailboxes.Responses.$200>;
|
|
7345
7346
|
/**
|
|
7346
|
-
* createMailbox
|
|
7347
|
+
* createMailbox - Create a folder. Refused with 400 when the account already has a folder at that path.
|
|
7347
7348
|
*/
|
|
7348
7349
|
'createMailbox'(
|
|
7349
7350
|
parameters?: Parameters<Paths.CreateMailbox.PathParameters> | null,
|
|
@@ -7736,7 +7737,7 @@ Ordering: oldest first, by the date the message was sent, with `threadMessageId`
|
|
|
7736
7737
|
config?: AxiosRequestConfig
|
|
7737
7738
|
): OperationResponse<Paths.ListThreadMessages.Responses.$200>;
|
|
7738
7739
|
/**
|
|
7739
|
-
* 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.
|
|
7740
|
+
* 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.
|
|
7740
7741
|
|
|
7741
7742
|
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.
|
|
7742
7743
|
|
|
@@ -7746,7 +7747,7 @@ Pagination: pass the returned `continuationToken` to fetch the next page; keep p
|
|
|
7746
7747
|
|
|
7747
7748
|
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.
|
|
7748
7749
|
|
|
7749
|
-
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
|
|
7750
|
+
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.
|
|
7750
7751
|
|
|
7751
7752
|
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.
|
|
7752
7753
|
|
|
@@ -8127,7 +8128,7 @@ export interface PathsDictionary {
|
|
|
8127
8128
|
config?: AxiosRequestConfig
|
|
8128
8129
|
): OperationResponse<Paths.ListMailboxes.Responses.$200>;
|
|
8129
8130
|
/**
|
|
8130
|
-
* createMailbox
|
|
8131
|
+
* createMailbox - Create a folder. Refused with 400 when the account already has a folder at that path.
|
|
8131
8132
|
*/
|
|
8132
8133
|
'post'(
|
|
8133
8134
|
parameters?: Parameters<Paths.CreateMailbox.PathParameters> | null,
|
|
@@ -8572,7 +8573,7 @@ Ordering: oldest first, by the date the message was sent, with `threadMessageId`
|
|
|
8572
8573
|
};
|
|
8573
8574
|
['/threads']: {
|
|
8574
8575
|
/**
|
|
8575
|
-
* 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.
|
|
8576
|
+
* 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.
|
|
8576
8577
|
|
|
8577
8578
|
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.
|
|
8578
8579
|
|
|
@@ -8582,7 +8583,7 @@ Pagination: pass the returned `continuationToken` to fetch the next page; keep p
|
|
|
8582
8583
|
|
|
8583
8584
|
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.
|
|
8584
8585
|
|
|
8585
|
-
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
|
|
8586
|
+
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.
|
|
8586
8587
|
|
|
8587
8588
|
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.
|
|
8588
8589
|
|