@remit/api-openapi-spec 0.0.44 → 0.0.46

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/openapi.json +64 -5
  2. package/package.json +1 -1
package/openapi.json CHANGED
@@ -7072,7 +7072,7 @@
7072
7072
  "$ref": "#/components/schemas/RemitImap.MessageCategory"
7073
7073
  }
7074
7074
  ],
7075
- "description": "Header-derived category for the message. Always present: `Message.category` is NOT NULL with an `uncategorized` default, and `uncategorized` names the not-yet-classified state rather than standing for absence (issue #45)."
7075
+ "description": "Header-derived category for the message. Always present: `Message.category` is NOT NULL with an `uncategorized` default, and `uncategorized` is a named value — no category — rather than a stand-in for absence or for `personal` (issue #45)."
7076
7076
  },
7077
7077
  "senderTrust": {
7078
7078
  "allOf": [
@@ -7823,7 +7823,7 @@
7823
7823
  "transactional",
7824
7824
  "social"
7825
7825
  ],
7826
- "description": "Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized` until the message is body-classified."
7826
+ "description": "Header-derived message category. Set by classifyByHeaders during body-sync. Defaults to `uncategorized`, which covers both a message that has not been classified yet and one the classifier declined to categorize; `Message.classificationState` is what tells those apart."
7827
7827
  },
7828
7828
  "RemitImap.MessageReferenceResponse": {
7829
7829
  "type": "object",
@@ -7871,6 +7871,16 @@
7871
7871
  },
7872
7872
  "description": "Recorded when the user reported this message as spam via `POST /messages/report-spam`. Present means the report stands; absent means never reported, or reported and then undone via `POST /messages/not-spam` (which clears it). Backs the \"Reported as spam · Undo\" affordance independent of the message's current folder — the underlying move can settle, fail, or no-op (already in Junk) without changing whether the report itself is shown."
7873
7873
  },
7874
+ "RemitImap.MessageStatus": {
7875
+ "type": "string",
7876
+ "enum": [
7877
+ "active",
7878
+ "deleting",
7879
+ "deleted",
7880
+ "moving"
7881
+ ],
7882
+ "description": "Message lifecycle status for move/delete operations"
7883
+ },
7874
7884
  "RemitImap.MessageSummaryResponse": {
7875
7885
  "type": "object",
7876
7886
  "required": [
@@ -7878,7 +7888,9 @@
7878
7888
  "mailboxId",
7879
7889
  "uid",
7880
7890
  "rfc822Size",
7881
- "internalDate"
7891
+ "internalDate",
7892
+ "status",
7893
+ "syncStatus"
7882
7894
  ],
7883
7895
  "properties": {
7884
7896
  "messageId": {
@@ -7924,6 +7936,26 @@
7924
7936
  "description": "Message-ID header value for quick reference",
7925
7937
  "readOnly": true
7926
7938
  },
7939
+ "status": {
7940
+ "allOf": [
7941
+ {
7942
+ "$ref": "#/components/schemas/RemitImap.MessageStatus"
7943
+ }
7944
+ ],
7945
+ "description": "Message lifecycle status for move/delete operations. Defaults to `active` (normal, visible).",
7946
+ "default": "active",
7947
+ "readOnly": true
7948
+ },
7949
+ "syncStatus": {
7950
+ "allOf": [
7951
+ {
7952
+ "$ref": "#/components/schemas/RemitImap.MessageSyncStatus"
7953
+ }
7954
+ ],
7955
+ "description": "Sync status for move/delete operations. The `synced` column default only applies to a row written without the field: the repository always supplies one, and an ordinary inbound sync writes `pending`, which nothing later promotes. So `pending` here does not mean an outstanding move or delete — `status` names that, and `failed` marks a mutation that gave up.",
7956
+ "default": "synced",
7957
+ "readOnly": true
7958
+ },
7927
7959
  "authenticity": {
7928
7960
  "allOf": [
7929
7961
  {
@@ -7959,6 +7991,15 @@
7959
7991
  },
7960
7992
  "description": "Core message metadata for API responses"
7961
7993
  },
7994
+ "RemitImap.MessageSyncStatus": {
7995
+ "type": "string",
7996
+ "enum": [
7997
+ "synced",
7998
+ "pending",
7999
+ "failed"
8000
+ ],
8001
+ "description": "Sync status for message move/delete operations"
8002
+ },
7962
8003
  "RemitImap.MintOutboxAttachmentInput": {
7963
8004
  "type": "object",
7964
8005
  "required": [
@@ -9494,7 +9535,9 @@
9494
9535
  "updatedAt",
9495
9536
  "category",
9496
9537
  "senderTrust",
9497
- "muted"
9538
+ "muted",
9539
+ "status",
9540
+ "syncStatus"
9498
9541
  ],
9499
9542
  "properties": {
9500
9543
  "threadMessageId": {
@@ -9618,7 +9661,7 @@
9618
9661
  "$ref": "#/components/schemas/RemitImap.MessageCategory"
9619
9662
  }
9620
9663
  ],
9621
- "description": "Header-derived category for the message, served from the ThreadMessage row. Always present: the column is NOT NULL with an `uncategorized` default, and `uncategorized` is a named value for the not-yet-classified state, never a stand-in for `personal` (issue #45)."
9664
+ "description": "Header-derived category for the message, served from the ThreadMessage row. Always present: the column is NOT NULL with an `uncategorized` default, and `uncategorized` is a named value — no category — never a stand-in for `personal` (issue #45)."
9622
9665
  },
9623
9666
  "senderTrust": {
9624
9667
  "allOf": [
@@ -9640,6 +9683,22 @@
9640
9683
  ],
9641
9684
  "description": "Structured sender-authenticity signal derived from DKIM headers at classification time (from the underlying Message). Absent for messages classified before this field was introduced — absence means no signal."
9642
9685
  },
9686
+ "status": {
9687
+ "allOf": [
9688
+ {
9689
+ "$ref": "#/components/schemas/RemitImap.MessageStatus"
9690
+ }
9691
+ ],
9692
+ "description": "Mutation lifecycle of the underlying Message, projected at read time — the ThreadMessage row has no column of its own. `active` means no move or delete is outstanding; `moving` or `deleting` means one is, and this row's folder is a local write the mail server has not confirmed."
9693
+ },
9694
+ "syncStatus": {
9695
+ "allOf": [
9696
+ {
9697
+ "$ref": "#/components/schemas/RemitImap.MessageSyncStatus"
9698
+ }
9699
+ ],
9700
+ "description": "Sync status of the underlying Message, projected at read time. Read it WITH `status`, never alone: `message-move`, `message-delete` and `message-copy` all write `failed` on an ordinary transient attempt before a redelivery that usually succeeds, so `failed` by itself does not mean a mutation gave up. One pair does prove one: `active` + `failed`, written only by `abandonDelete` — a delete Remit refused to run and handed back. Nothing else here is decidable. A move that gave up leaves `moving` + `failed`, the same pair its first dropped connection leaves; a delete that exhausted its retries is repaired to `active` + `synced` and reads as settled; `flag-push` and `placement-move-push` never write either field."
9701
+ },
9643
9702
  "accountId": {
9644
9703
  "allOf": [
9645
9704
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remit/api-openapi-spec",
3
- "version": "0.0.44",
3
+ "version": "0.0.46",
4
4
  "description": "Remit API OpenAPI 3 document, generated from TypeSpec.",
5
5
  "exports": {
6
6
  ".": "./openapi.json",