@remit/api-openapi-types 0.0.13 → 0.0.15
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 +33 -9
package/package.json
CHANGED
package/types.d.ts
CHANGED
|
@@ -114,9 +114,9 @@ current enum emitter anyway, so the wire contract uses the bare form.
|
|
|
114
114
|
*/
|
|
115
115
|
export type FilterMatchOperator = "And" | "Or";
|
|
116
116
|
/**
|
|
117
|
-
* Message attribute a FilterClause matches against — RFC 031's Tier 0 literal predicates (
|
|
117
|
+
* Message attribute a FilterClause matches against — RFC 031's Tier 0 literal predicates plus the RFC 038 D2 additions (list membership and sender domain). Every member is matched vector-free at index time and in the back-apply corpus projection.
|
|
118
118
|
*/
|
|
119
|
-
export type FilterClauseField = "From" | "Subject" | "HasWords";
|
|
119
|
+
export type FilterClauseField = "From" | "Subject" | "HasWords" | "ListId" | "FromDomain";
|
|
120
120
|
/**
|
|
121
121
|
* Lifecycle state of a smart-organize back-apply job (RFC 034, #1278). Mirrors the account-export job's lifecycle: a Pending row the worker picks up, drives to Running, then to a terminal Complete or Failed.
|
|
122
122
|
*/
|
|
@@ -1438,11 +1438,11 @@ data through `byAccountAndState`.
|
|
|
1438
1438
|
*/
|
|
1439
1439
|
name: String256;
|
|
1440
1440
|
/**
|
|
1441
|
-
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1).
|
|
1441
|
+
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1). Mutable on update (reader #266): switching scope re-derives ttl and re-evaluates state from expiresAt, and bumps ruleChangedAt so a lapsed filter's back-application can be offered again. The semantic anchor stays immutable regardless — repointing it would silently change what a saved filter matches with nothing visible changing, which deserves a new filter instead.
|
|
1442
1442
|
*/
|
|
1443
1443
|
scope: FilterScope;
|
|
1444
1444
|
/**
|
|
1445
|
-
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence.
|
|
1445
|
+
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence. Mutable on update (reader #266), alongside scope — moving the date bumps ruleChangedAt the same way a scope change does.
|
|
1446
1446
|
*/
|
|
1447
1447
|
expiresAt?: string;
|
|
1448
1448
|
/**
|
|
@@ -1510,11 +1510,11 @@ data through `byAccountAndState`.
|
|
|
1510
1510
|
*/
|
|
1511
1511
|
name: String256;
|
|
1512
1512
|
/**
|
|
1513
|
-
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1).
|
|
1513
|
+
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1). Mutable on update (reader #266): switching scope re-derives ttl and re-evaluates state from expiresAt, and bumps ruleChangedAt so a lapsed filter's back-application can be offered again. The semantic anchor stays immutable regardless — repointing it would silently change what a saved filter matches with nothing visible changing, which deserves a new filter instead.
|
|
1514
1514
|
*/
|
|
1515
1515
|
scope: FilterScope;
|
|
1516
1516
|
/**
|
|
1517
|
-
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence.
|
|
1517
|
+
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence. Mutable on update (reader #266), alongside scope — moving the date bumps ruleChangedAt the same way a scope change does.
|
|
1518
1518
|
*/
|
|
1519
1519
|
expiresAt?: string;
|
|
1520
1520
|
/**
|
|
@@ -1564,11 +1564,11 @@ sets `hasAnchor`. Absent for a purely-literal filter.
|
|
|
1564
1564
|
*/
|
|
1565
1565
|
name: String256;
|
|
1566
1566
|
/**
|
|
1567
|
-
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1).
|
|
1567
|
+
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1). Mutable on update (reader #266): switching scope re-derives ttl and re-evaluates state from expiresAt, and bumps ruleChangedAt so a lapsed filter's back-application can be offered again. The semantic anchor stays immutable regardless — repointing it would silently change what a saved filter matches with nothing visible changing, which deserves a new filter instead.
|
|
1568
1568
|
*/
|
|
1569
1569
|
scope: FilterScope;
|
|
1570
1570
|
/**
|
|
1571
|
-
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence.
|
|
1571
|
+
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence. Mutable on update (reader #266), alongside scope — moving the date bumps ruleChangedAt the same way a scope change does.
|
|
1572
1572
|
*/
|
|
1573
1573
|
expiresAt?: string;
|
|
1574
1574
|
/**
|
|
@@ -1593,13 +1593,33 @@ sets `hasAnchor`. Absent for a purely-literal filter.
|
|
|
1593
1593
|
anchorMessageId?: UUID;
|
|
1594
1594
|
}
|
|
1595
1595
|
/**
|
|
1596
|
-
* Input for updating a filter (RFC 034).
|
|
1596
|
+
* Input for updating a filter (RFC 034, reader #266). The name, predicate,
|
|
1597
|
+
action, scope, and expiresAt are all updatable; `ttl` is always
|
|
1598
|
+
server-derived from `scope`/`expiresAt`, never client-supplied, and
|
|
1599
|
+
`state`/`hasAnchor`/`ruleChangedAt`/`filterId` are server-derived too. A
|
|
1600
|
+
patch touching the predicate, the action, `scope`, or `expiresAt` bumps
|
|
1601
|
+
`ruleChangedAt`; a name-only rename never does (RFC 034 Decision 3.2, reader
|
|
1602
|
+
#266).
|
|
1603
|
+
|
|
1604
|
+
The semantic anchor has no field here at all — it is set once, from
|
|
1605
|
+
`anchorMessageId`, only on `CreateFilterInput`. Repointing an anchor would
|
|
1606
|
+
silently change what a saved filter matches with nothing visible changing;
|
|
1607
|
+
that deserves a new filter, so the server rejects any attempt to smuggle an
|
|
1608
|
+
anchor change through this body (reader #266).
|
|
1597
1609
|
*/
|
|
1598
1610
|
export interface UpdateFilterInput {
|
|
1599
1611
|
/**
|
|
1600
1612
|
* Plain-language name or editable label for this filter
|
|
1601
1613
|
*/
|
|
1602
1614
|
name: String256;
|
|
1615
|
+
/**
|
|
1616
|
+
* Standing (permanent) or Temporary (expires). Governs whether expiresAt/ttl are present (RFC 034 Decision 1). Mutable on update (reader #266): switching scope re-derives ttl and re-evaluates state from expiresAt, and bumps ruleChangedAt so a lapsed filter's back-application can be offered again. The semantic anchor stays immutable regardless — repointing it would silently change what a saved filter matches with nothing visible changing, which deserves a new filter instead.
|
|
1617
|
+
*/
|
|
1618
|
+
scope: FilterScope;
|
|
1619
|
+
/**
|
|
1620
|
+
* ISO 8601 date-time with zone offset, present only when scope is Temporary (RFC 034 Decision 1.1) — a business date, not an epoch instant. Every evaluation compares `now` against this value directly; it is the source of truth for whether a Temporary filter is still active, independent of `state` or row existence. Mutable on update (reader #266), alongside scope — moving the date bumps ruleChangedAt the same way a scope change does.
|
|
1621
|
+
*/
|
|
1622
|
+
expiresAt?: string;
|
|
1603
1623
|
/**
|
|
1604
1624
|
* How literalClauses combine. Meaningless when literalClauses is empty.
|
|
1605
1625
|
*/
|
|
@@ -2195,6 +2215,10 @@ standing to persist.
|
|
|
2195
2215
|
* Message subject
|
|
2196
2216
|
*/
|
|
2197
2217
|
subject?: string;
|
|
2218
|
+
/**
|
|
2219
|
+
* Normalized `List-Id` header value (bracketed identifier, case-folded), denormalized at body-sync so the back-apply corpus projection can match a `ListId` clause vector-free. Absent when the message carries no `List-Id` header or was body-synced before this field existed.
|
|
2220
|
+
*/
|
|
2221
|
+
listId?: String256;
|
|
2198
2222
|
/**
|
|
2199
2223
|
* IMAP INTERNALDATE timestamp (when server received the message)
|
|
2200
2224
|
*/
|