@remit/api-openapi-types 0.0.58 → 0.0.60

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +38 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-types",
3
- "version": "0.0.58",
3
+ "version": "0.0.60",
4
4
  "type": "module",
5
5
  "main": "types.d.ts",
6
6
  "types": "types.d.ts",
package/types.d.ts CHANGED
@@ -239,7 +239,7 @@ distinguishable from a network failure without parsing prose.
239
239
  /**
240
240
  * Names a key of `AddressFlags` that a client may address in `PATCH /addresses/{addressId}`. `wellknown` is deliberately absent: it is server-owned, derived from engagement counters, and is never written or removed by a client.
241
241
  */
242
- export type AddressFlagKey = "trusted" | "blocked" | "muted" | "vip" | "junkOnly" | "category" | "autoArchive" | "unsubscribed";
242
+ export type AddressFlagKey = "trusted" | "blocked" | "muted" | "vip" | "junkOnly" | "category" | "autoArchive" | "unsubscribed" | "neverSpam";
243
243
  /**
244
244
  * Whether the header classifier has examined a message's body (issue #331). Persistence-level state on `Message`, deliberately off the wire: no response model carries it. It exists because `category` cannot answer this question — `uncategorized` is both the value a metadata-synced row starts at and the answer the classifier gives when it has nothing to say, so a guard reading `category` alone cannot tell "never examined" from "examined and declined" and re-reads the stored body on every sync pass forever.
245
245
  */
@@ -316,6 +316,10 @@ distinguishable from a network failure without parsing prose.
316
316
  * Content encoding/compression types for stored content
317
317
  */
318
318
  export type ContentEncoding = "none" | "gzip" | "zstd";
319
+ /**
320
+ * What the user has instructed about a sender's placement, resolved from AddressFlags at read time. An instruction, not a heuristic signal: it outranks every DKIM/DMARC/provider verdict. `SenderTrust` stays a separate axis and is unaffected.
321
+ */
322
+ export type SenderOverride = "none" | "blocked" | "neverSpam";
319
323
  /**
320
324
  * Known user-setting keys. Each maps, in the registry, to a required value kind and a zod schema. New keys are added deliberately by extending this enum and the registry — never as an ad-hoc column.
321
325
  */
@@ -2318,6 +2322,10 @@ vectors at match time and never persisted as a FilterAnchor row.
2318
2322
  * True when the semantic widen could not run because this deployment ships no vector pipeline (self-host without sqlite-vec / the embedding model). The matched set is then the literal matches only, or empty for an anchor-only predicate; literal search is unaffected. Absent on deployments where the widen ran.
2319
2323
  */
2320
2324
  semanticUnavailable?: boolean;
2325
+ /**
2326
+ * True when the widen ran but this account's semantic index held nothing to answer with — no vectors at all, or none yet for the anchor message. A zero count is then a fact about the index, which is still filling, rather than about the rule. Absent when the index answered.
2327
+ */
2328
+ semanticIndexEmpty?: boolean;
2321
2329
  }
2322
2330
  /**
2323
2331
  * An async "all like these" back-apply job (RFC 034 recap, #1278). Modeled on
@@ -4270,6 +4278,7 @@ either way and cannot tell which it received.
4270
4278
  export interface AddressFlags {
4271
4279
  trusted?: TrustedFlag;
4272
4280
  blocked?: BlockedFlag;
4281
+ neverSpam?: NeverSpamFlag;
4273
4282
  muted?: MutedFlag;
4274
4283
  vip?: VipFlag;
4275
4284
  wellknown?: WellknownFlag;
@@ -4322,6 +4331,28 @@ either way and cannot tell which it received.
4322
4331
  reason?: string;
4323
4332
  value: boolean;
4324
4333
  }
4334
+ /**
4335
+ * Sender is never spam: their mail is rescued from Junk whatever the authentication signals say. Mutually exclusive with `blocked` — the flag written last removes the other.
4336
+ */
4337
+ export interface NeverSpamFlag {
4338
+ /**
4339
+ * Timestamp when the flag was set
4340
+ */
4341
+ setAt: number;
4342
+ /**
4343
+ * Device/session/user identifier that set the flag (audit trail)
4344
+ */
4345
+ setBy?: string;
4346
+ /**
4347
+ * Optional auto-revoke timestamp
4348
+ */
4349
+ expiresAt?: number;
4350
+ /**
4351
+ * Free-text user note
4352
+ */
4353
+ reason?: string;
4354
+ value: boolean;
4355
+ }
4325
4356
  /**
4326
4357
  * Sender is VIP: priority surface and push escalation
4327
4358
  */
@@ -4528,6 +4559,10 @@ either way and cannot tell which it received.
4528
4559
  export interface UpdateAddressFlagsInput {
4529
4560
  trusted?: TrustedFlag | any;
4530
4561
  blocked?: BlockedFlag | any;
4562
+ /**
4563
+ * Setting this to `value: true` removes `blocked`, and setting `blocked` removes this one; the two cannot both stand
4564
+ */
4565
+ neverSpam?: NeverSpamFlag | any;
4531
4566
  muted?: MutedFlag | any;
4532
4567
  vip?: VipFlag | any;
4533
4568
  wellknown?: WellknownFlag | any;
@@ -8940,6 +8975,7 @@ export type Address = Components.Schemas.Address;
8940
8975
  export type AddressFlags = Components.Schemas.AddressFlags;
8941
8976
  export type TrustedFlag = Components.Schemas.TrustedFlag;
8942
8977
  export type BlockedFlag = Components.Schemas.BlockedFlag;
8978
+ export type NeverSpamFlag = Components.Schemas.NeverSpamFlag;
8943
8979
  export type VipFlag = Components.Schemas.VipFlag;
8944
8980
  export type WellknownFlag = Components.Schemas.WellknownFlag;
8945
8981
  export type JunkOnlyFlag = Components.Schemas.JunkOnlyFlag;
@@ -9072,6 +9108,7 @@ export type MessageKeywordFlag = Components.Schemas.MessageKeywordFlag;
9072
9108
  export type MailboxAttribute = Components.Schemas.MailboxAttribute;
9073
9109
  export type StorageType = Components.Schemas.StorageType;
9074
9110
  export type ContentEncoding = Components.Schemas.ContentEncoding;
9111
+ export type SenderOverride = Components.Schemas.SenderOverride;
9075
9112
  export type AccountSettingName = Components.Schemas.AccountSettingName;
9076
9113
  export type ConfigImportState = Components.Schemas.ConfigImportState;
9077
9114
  export type ConfigImportRefKind = Components.Schemas.ConfigImportRefKind;