@yigemo/choosefire 0.3.1 → 0.4.0

package/contracts/choosefire-family-wealth/v2/openapi.generated.json

@@ -1,6 +1,164 @@
 {
   "components": {
     "schemas": {
+      "AccountActivityTimelineItemV2": {
+        "oneOf": [
+          {
+            "additionalProperties": false,
+            "properties": {
+              "cashFlow": {
+                "$ref": "#/components/schemas/ExternalCashFlowV2"
+              },
+              "eventAt": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "kind": {
+                "const": "external_cash_flow"
+              }
+            },
+            "required": [
+              "kind",
+              "eventAt",
+              "cashFlow"
+            ],
+            "type": "object"
+          },
+          {
+            "additionalProperties": false,
+            "properties": {
+              "eventAt": {
+                "format": "date-time",
+                "type": "string"
+              },
+              "kind": {
+                "const": "investment_transaction"
+              },
+              "transaction": {
+                "$ref": "#/components/schemas/InvestmentTransactionV2"
+              }
+            },
+            "required": [
+              "kind",
+              "eventAt",
+              "transaction"
+            ],
+            "type": "object"
+          }
+        ]
+      },
+      "AccountActivityTimelineQueryV2": {
+        "additionalProperties": false,
+        "properties": {
+          "accountId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "holdingId": {
+            "anyOf": [
+              {
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "accountId",
+          "holdingId"
+        ],
+        "type": "object"
+      },
+      "AccountActivityTimelineSuccessV2": {
+        "additionalProperties": false,
+        "properties": {
+          "code": {
+            "const": 0
+          },
+          "data": {
+            "$ref": "#/components/schemas/AccountActivityTimelineV2"
+          },
+          "kind": {
+            "const": "family_wealth_success.v2"
+          },
+          "status": {
+            "const": "success"
+          },
+          "success": {
+            "const": true
+          }
+        },
+        "required": [
+          "kind",
+          "success",
+          "status",
+          "code",
+          "data"
+        ],
+        "type": "object"
+      },
+      "AccountActivityTimelineV2": {
+        "additionalProperties": false,
+        "properties": {
+          "accountId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "asOf": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "authority": {
+            "$ref": "#/components/schemas/WorkspaceAuthorityV2"
+          },
+          "contractVersion": {
+            "const": 2
+          },
+          "holdingId": {
+            "anyOf": [
+              {
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "items": {
+            "items": {
+              "$ref": "#/components/schemas/AccountActivityTimelineItemV2"
+            },
+            "maxItems": 1000,
+            "type": "array"
+          },
+          "kind": {
+            "const": "account.activity_timeline.v2"
+          },
+          "projectionVersion": {
+            "const": 1
+          },
+          "workspaceVersion": {
+            "minimum": 1,
+            "type": "integer"
+          }
+        },
+        "required": [
+          "kind",
+          "contractVersion",
+          "projectionVersion",
+          "workspaceVersion",
+          "asOf",
+          "authority",
+          "accountId",
+          "holdingId",
+          "items"
+        ],
+        "type": "object"
+      },
       "AccountTimelineQueryV2": {
         "additionalProperties": false,
         "properties": {
@@ -114,7 +272,8 @@
                     "valuation_snapshot",
                     "classification",
                     "holding",
-                    "external_cash_flow"
+                    "external_cash_flow",
+                    "investment_transaction"
                   ]
                 }
               },
@@ -151,7 +310,10 @@
               "holding.create.v2",
               "holding.update.v2",
               "holding.archive.v2",
-              "external_cash_flow.record.v2"
+              "external_cash_flow.record.v2",
+              "investment_transaction.create.v2",
+              "investment_transaction.update.v2",
+              "investment_transaction.archive.v2"
             ]
           },
           "operationId": {
@@ -1387,7 +1549,362 @@
               }
             ]
           },
-          "quantityAsOf": {
+          "quantityAsOf": {
+            "anyOf": [
+              {
+                "format": "date-time",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "revision": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "source": {
+            "$ref": "#/components/schemas/SourceV2"
+          },
+          "valuation": {
+            "$ref": "#/components/schemas/OverviewValuationV2"
+          }
+        },
+        "required": [
+          "holdingId",
+          "accountId",
+          "name",
+          "instrumentRef",
+          "quantity",
+          "quantityAsOf",
+          "currency",
+          "quality",
+          "source",
+          "revision",
+          "classificationRevision",
+          "classificationSource",
+          "assetClasses",
+          "purposeBuckets",
+          "valuation"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionArchiveCommandV2": {
+        "additionalProperties": false,
+        "properties": {
+          "commandId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "expectedObjectRevision": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "expectedWorkspaceVersion": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "idempotencyKey": {
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,199}$",
+            "type": "string"
+          },
+          "kind": {
+            "const": "investment_transaction.archive.v2"
+          },
+          "payload": {
+            "$ref": "#/components/schemas/InvestmentTransactionArchivePayloadV2"
+          },
+          "source": {
+            "$ref": "#/components/schemas/SourceV2"
+          }
+        },
+        "required": [
+          "kind",
+          "commandId",
+          "idempotencyKey",
+          "expectedWorkspaceVersion",
+          "expectedObjectRevision",
+          "source",
+          "payload"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionArchivePayloadV2": {
+        "additionalProperties": false,
+        "properties": {
+          "reason": {
+            "maxLength": 240,
+            "minLength": 1,
+            "type": "string"
+          },
+          "transactionId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "transactionId",
+          "reason"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionCreateCommandV2": {
+        "additionalProperties": false,
+        "properties": {
+          "commandId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "expectedObjectRevision": {
+            "type": "null"
+          },
+          "expectedWorkspaceVersion": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "idempotencyKey": {
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,199}$",
+            "type": "string"
+          },
+          "kind": {
+            "const": "investment_transaction.create.v2"
+          },
+          "payload": {
+            "$ref": "#/components/schemas/InvestmentTransactionCreatePayloadV2"
+          },
+          "source": {
+            "$ref": "#/components/schemas/SourceV2"
+          }
+        },
+        "required": [
+          "kind",
+          "commandId",
+          "idempotencyKey",
+          "expectedWorkspaceVersion",
+          "expectedObjectRevision",
+          "source",
+          "payload"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionCreatePayloadV2": {
+        "additionalProperties": false,
+        "properties": {
+          "transaction": {
+            "$ref": "#/components/schemas/InvestmentTransactionDraftV2"
+          },
+          "transactionId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "transactionId",
+          "transaction"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionDraftV2": {
+        "additionalProperties": false,
+        "properties": {
+          "accountId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "amount": {
+            "$ref": "#/components/schemas/MoneyV2"
+          },
+          "holdingId": {
+            "anyOf": [
+              {
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "price": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/MoneyV2"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "quality": {
+            "$ref": "#/components/schemas/QualityV2"
+          },
+          "quantity": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/DecimalQuantityV2"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "settledAt": {
+            "anyOf": [
+              {
+                "format": "date-time",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "source": {
+            "$ref": "#/components/schemas/SourceV2"
+          },
+          "tradeAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "buy",
+              "sell",
+              "subscribe",
+              "redeem",
+              "dividend",
+              "interest",
+              "fee",
+              "tax",
+              "deposit",
+              "withdrawal",
+              "transfer_in",
+              "transfer_out",
+              "adjustment"
+            ]
+          }
+        },
+        "required": [
+          "accountId",
+          "holdingId",
+          "type",
+          "amount",
+          "quantity",
+          "price",
+          "tradeAt",
+          "settledAt",
+          "quality",
+          "source"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionUpdateCommandV2": {
+        "additionalProperties": false,
+        "properties": {
+          "commandId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "expectedObjectRevision": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "expectedWorkspaceVersion": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "idempotencyKey": {
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,199}$",
+            "type": "string"
+          },
+          "kind": {
+            "const": "investment_transaction.update.v2"
+          },
+          "payload": {
+            "$ref": "#/components/schemas/InvestmentTransactionUpdatePayloadV2"
+          },
+          "source": {
+            "$ref": "#/components/schemas/SourceV2"
+          }
+        },
+        "required": [
+          "kind",
+          "commandId",
+          "idempotencyKey",
+          "expectedWorkspaceVersion",
+          "expectedObjectRevision",
+          "source",
+          "payload"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionUpdatePayloadV2": {
+        "additionalProperties": false,
+        "properties": {
+          "transaction": {
+            "$ref": "#/components/schemas/InvestmentTransactionDraftV2"
+          },
+          "transactionId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "transactionId",
+          "transaction"
+        ],
+        "type": "object"
+      },
+      "InvestmentTransactionV2": {
+        "additionalProperties": false,
+        "properties": {
+          "accountId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "amount": {
+            "$ref": "#/components/schemas/MoneyV2"
+          },
+          "holdingId": {
+            "anyOf": [
+              {
+                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "price": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/MoneyV2"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "quality": {
+            "$ref": "#/components/schemas/QualityV2"
+          },
+          "quantity": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/DecimalQuantityV2"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "revision": {
+            "minimum": 1,
+            "type": "integer"
+          },
+          "settledAt": {
             "anyOf": [
               {
                 "format": "date-time",
@@ -1398,33 +1915,52 @@
               }
             ]
           },
-          "revision": {
-            "minimum": 1,
-            "type": "integer"
-          },
           "source": {
             "$ref": "#/components/schemas/SourceV2"
           },
-          "valuation": {
-            "$ref": "#/components/schemas/OverviewValuationV2"
+          "status": {
+            "const": "active"
+          },
+          "tradeAt": {
+            "format": "date-time",
+            "type": "string"
+          },
+          "transactionId": {
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "buy",
+              "sell",
+              "subscribe",
+              "redeem",
+              "dividend",
+              "interest",
+              "fee",
+              "tax",
+              "deposit",
+              "withdrawal",
+              "transfer_in",
+              "transfer_out",
+              "adjustment"
+            ]
           }
         },
         "required": [
-          "holdingId",
+          "transactionId",
           "accountId",
-          "name",
-          "instrumentRef",
+          "holdingId",
+          "type",
+          "amount",
           "quantity",
-          "quantityAsOf",
-          "currency",
+          "price",
+          "tradeAt",
+          "settledAt",
           "quality",
           "source",
-          "revision",
-          "classificationRevision",
-          "classificationSource",
-          "assetClasses",
-          "purposeBuckets",
-          "valuation"
+          "status",
+          "revision"
         ],
         "type": "object"
       },
@@ -2140,7 +2676,8 @@
                 "activity.page.v2",
                 "workspace.overview.v2",
                 "asset_account.detail.v2",
-                "account.timeline.v2"
+                "account.timeline.v2",
+                "account.activity_timeline.v2"
               ]
             },
             "type": "array",
@@ -2157,7 +2694,10 @@
                 "holding.create.v2",
                 "holding.update.v2",
                 "holding.archive.v2",
-                "external_cash_flow.record.v2"
+                "external_cash_flow.record.v2",
+                "investment_transaction.create.v2",
+                "investment_transaction.update.v2",
+                "investment_transaction.archive.v2"
               ]
             },
             "type": "array",
@@ -2869,8 +3409,8 @@
     }
   },
   "info": {
-    "title": "ChooseFIRE Family Wealth v2 R3 Holdings Contract",
-    "version": "2.0.0-r3-holdings"
+    "title": "ChooseFIRE Family Wealth v2 R3 Transaction Contract",
+    "version": "2.0.0-r3-transactions"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -3162,6 +3702,83 @@
         "summary": "Read one account and its bounded active holdings"
       }
     },
+    "/choosefire/v2/workspace/asset-accounts/{accountId}/activity-timeline": {
+      "get": {
+        "operationId": "getFamilyWealthAccountActivityTimelineV2",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "accountId",
+            "required": true,
+            "schema": {
+              "format": "uuid",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccountActivityTimelineSuccessV2"
+                }
+              }
+            },
+            "description": "Unified account activity timeline"
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          }
+        ],
+        "summary": "Read cash flows and investment transactions in one stable timeline"
+      }
+    },
+    "/choosefire/v2/workspace/asset-accounts/{accountId}/holdings/{holdingId}/activity-timeline": {
+      "get": {
+        "operationId": "getFamilyWealthHoldingActivityTimelineV2",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "accountId",
+            "required": true,
+            "schema": {
+              "format": "uuid",
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "holdingId",
+            "required": true,
+            "schema": {
+              "format": "uuid",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccountActivityTimelineSuccessV2"
+                }
+              }
+            },
+            "description": "Unified holding activity timeline"
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          }
+        ],
+        "summary": "Read the bounded transaction timeline for one holding"
+      }
+    },
     "/choosefire/v2/workspace/classifications": {
       "put": {
         "operationId": "replaceFamilyWealthClassificationV2",
@@ -3215,6 +3832,49 @@
         "summary": "Replace account or holding asset and purpose allocations"
       }
     },
+    "/choosefire/v2/workspace/external-cash-flows": {
+      "post": {
+        "operationId": "recordFamilyWealthExternalCashFlowV2",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ExternalCashFlowRecordCommandV2"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommandSuccessV2"
+                }
+              }
+            },
+            "description": "Committed cash-flow receipt"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FamilyWealthErrorV2"
+                }
+              }
+            },
+            "description": "Workspace or idempotency conflict"
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          }
+        ],
+        "summary": "Record one account-boundary cash flow"
+      }
+    },
     "/choosefire/v2/workspace/holdings": {
       "post": {
         "operationId": "createFamilyWealthHoldingV2",
@@ -3342,6 +4002,133 @@
         "summary": "Archive one active holding without deleting history"
       }
     },
+    "/choosefire/v2/workspace/investment-transactions": {
+      "post": {
+        "operationId": "createFamilyWealthInvestmentTransactionV2",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvestmentTransactionCreateCommandV2"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommandSuccessV2"
+                }
+              }
+            },
+            "description": "Committed transaction receipt"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FamilyWealthErrorV2"
+                }
+              }
+            },
+            "description": "Workspace or idempotency conflict"
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          }
+        ],
+        "summary": "Create one investment transaction under a detailed account"
+      },
+      "put": {
+        "operationId": "updateFamilyWealthInvestmentTransactionV2",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvestmentTransactionUpdateCommandV2"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommandSuccessV2"
+                }
+              }
+            },
+            "description": "Committed transaction update receipt"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FamilyWealthErrorV2"
+                }
+              }
+            },
+            "description": "Workspace or transaction revision conflict"
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          }
+        ],
+        "summary": "Replace one active investment transaction"
+      }
+    },
+    "/choosefire/v2/workspace/investment-transactions/archive": {
+      "post": {
+        "operationId": "archiveFamilyWealthInvestmentTransactionV2",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/InvestmentTransactionArchiveCommandV2"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommandSuccessV2"
+                }
+              }
+            },
+            "description": "Committed transaction archive receipt"
+          },
+          "409": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FamilyWealthErrorV2"
+                }
+              }
+            },
+            "description": "Workspace or transaction revision conflict"
+          }
+        },
+        "security": [
+          {
+            "bearer": []
+          }
+        ],
+        "summary": "Archive one active investment transaction without deleting history"
+      }
+    },
     "/choosefire/v2/workspace/mcp/delegation": {
       "post": {
         "operationId": "issueFamilyWealthWorkspaceMcpDelegationV2",
@@ -3510,5 +4297,5 @@
   },
   "x-choosefire-contract-id": "choosefire-family-wealth.v2",
   "x-choosefire-contract-version": 2,
-  "x-choosefire-runtime-state": "r3-holdings-parity"
+  "x-choosefire-runtime-state": "r3-transaction-web-parity"
 }