@stridge/openapi 0.5.0 → 0.5.1

package/dist/openapi.json

@@ -145,7 +145,7 @@
           "UDA"
         ],
         "summary": "Create a UDA address",
-        "description": "Allocate a new Universal Deposit Address for your tenant. If a UDA for the `(tenant, owner)` pair already exists, the existing record is returned with `200` instead of an error. `accepted_assets` is a list of asset symbols (e.g. `[\"USDC\", \"USDT\"]`); if empty, the UDA accepts every asset configured on every UDA-supported chain.\n",
+        "description": "Allocate a new Universal Deposit Address for your tenant. The call is idempotent on the owner and the destination together: if a UDA with the same `owner` and the same destination already exists, the existing record is returned with `200` instead of a duplicate. The destination is the treasury for a treasury-backed UDA, or the `(network_id, address, asset)` triple for an inline one; a treasury-backed UDA and an inline UDA are never collapsed into one, even when they point at the same wallet. The same owner with a different destination gets a new UDA. `accepted_assets` is a list of asset symbols (e.g. `[\"USDC\", \"USDT\"]`); if empty, the UDA accepts every asset configured on every UDA-supported chain.\n",
         "security": [
           {
             "ApiKeyAuth": []
@@ -169,7 +169,7 @@
         },
         "responses": {
           "200": {
-            "description": "An existing UDA address for the `(tenant, owner)` pair was returned.",
+            "description": "An existing UDA address with the same `owner` and destination was returned.",
             "content": {
               "application/json": {
                 "schema": {
@@ -2677,8 +2677,8 @@
           },
           "version": {
             "type": "string",
-            "description": "The envelope format version.",
-            "example": "1"
+            "description": "The event format version: `v1` for most events; payout, transfer and treasury events send `1.0.0`.",
+            "example": "v1"
           },
           "type": {
             "type": "string",
@@ -2744,7 +2744,7 @@
         ],
         "example": {
           "id": "7401d9c7-e29d-4374-8952-af40f05168b7",
-          "version": "1",
+          "version": "v1",
           "type": "uda.settlement.completed",
           "time": "2026-10-24T11:59:25Z",
           "livemode": false,
@@ -2752,8 +2752,8 @@
           "reset_epoch": 2,
           "payload": {
             "id": "stl_71829304a5b6c7d8",
-            "uda_id": "uda_2f8c1a9d4e5f6071",
-            "status": "completed"
+            "uda_address_id": "uda_2f8c1a9d4e5f6071",
+            "state": "completed"
           }
         }
       },
@@ -2823,49 +2823,55 @@
       },
       "DestinationInput": {
         "type": "object",
-        "description": "Where settlements for this UDA should be delivered.",
+        "description": "Where settlements for this UDA should be delivered, in exactly one of two forms: `treasury` (the name of one of your treasuries, so a rotation of the treasury moves the UDA with it), or inline `network_id` + `address` (+ `asset_symbol`), fixed at create time. Sending both forms is rejected with `400`.\n",
         "properties": {
+          "treasury": {
+            "type": "string",
+            "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
+            "example": "main"
+          },
           "address": {
             "type": "string",
-            "description": "Destination wallet address.",
+            "description": "Destination wallet address (inline form).",
             "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
           },
           "network_id": {
             "type": "string",
-            "description": "Destination SLIP-44 network id.",
+            "description": "Destination SLIP-44 network id (inline form).",
             "example": "60"
           },
           "asset_symbol": {
             "type": "string",
-            "description": "Destination asset symbol.",
+            "description": "Destination asset symbol (inline form).",
             "example": "USDC"
           }
-        },
-        "required": [
-          "address",
-          "network_id"
-        ]
+        }
       },
       "RoutingRuleMatchInput": {
         "type": "object",
-        "description": "Conditions a deposit must meet for this routing rule to apply.",
+        "description": "Conditions a deposit must meet for this routing rule to apply. At least one of the two fields is required: both pin one asset on one network, `source_network_id` alone matches any asset on that network, and `source_asset_symbol` alone matches that asset on any network. Two rules on one UDA may not share the same match.\n",
         "properties": {
           "source_network_id": {
             "type": "string",
+            "description": "Source SLIP-44 network id.",
             "example": "60"
           },
           "source_asset_symbol": {
             "type": "string",
+            "description": "Source asset symbol; must be one of the UDA's `accepted_assets` when that list is set.",
             "example": "USDT"
           }
-        },
-        "required": [
-          "source_network_id"
-        ]
+        }
       },
       "RoutingRuleDestinationInput": {
         "type": "object",
+        "description": "Where a matching deposit settles, in the same two forms as the UDA's `destination`: a `treasury` name, or inline `network_id` + `address` (+ `asset_symbol`). Sending both forms is rejected with `400`.\n",
         "properties": {
+          "treasury": {
+            "type": "string",
+            "description": "Name of one of your treasuries. Leave the inline fields empty when set.",
+            "example": "main"
+          },
           "address": {
             "type": "string",
             "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -2878,11 +2884,7 @@
             "type": "string",
             "example": "USDC"
           }
-        },
-        "required": [
-          "address",
-          "network_id"
-        ]
+        }
       },
       "RoutingRuleInput": {
         "type": "object",
@@ -2923,10 +2925,11 @@
           },
           "routing_rules": {
             "type": "array",
+            "maxItems": 5,
             "items": {
               "$ref": "#/components/schemas/RoutingRuleInput"
             },
-            "description": "Optional; max 3. Specificity-wins precedence: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule. When nothing matches, settlements use the default destination.\n"
+            "description": "Optional; max 5. Specificity wins, whatever the order: a rule pinning both `source_network_id` and `source_asset_symbol` beats a network-only rule, and either beats an asset-only rule. When no rule matches, the UDA's routing policy is consulted, and when that does not match either, settlements use the default destination.\n"
           },
           "routing_policy_id": {
             "type": "string",
@@ -3011,6 +3014,11 @@
         "type": "object",
         "description": "Resolved destination (symbol plus the resolved contract address).",
         "properties": {
+          "treasury": {
+            "type": "string",
+            "description": "The treasury name; present only for a treasury-backed destination.",
+            "example": "main"
+          },
           "address": {
             "type": "string",
             "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -3061,6 +3069,11 @@
       "RoutingRuleDestination": {
         "type": "object",
         "properties": {
+          "treasury": {
+            "type": "string",
+            "description": "The treasury name; present only for a treasury-backed destination.",
+            "example": "main"
+          },
           "address": {
             "type": "string",
             "example": "0x3a1f8b2c9d4e5f60718293a4b5c6d7e8f9012345"
@@ -3428,6 +3441,7 @@
       },
       "SettlementFees": {
         "type": "object",
+        "description": "What was taken between the deposit and the settlement, as integer strings in the base units of the deposit's asset (not the destination asset).\n",
         "properties": {
           "total": {
             "type": "string",
@@ -3483,11 +3497,16 @@
             "type": "string",
             "enum": [
               "created",
+              "refill_pending",
+              "refill_confirmed",
+              "awaiting_credit",
               "routing",
+              "retrying",
               "completed",
               "failed",
-              "retrying"
+              "refunded"
             ],
+            "description": "Where the settlement is in its lifecycle. `created`: the deposit was credited and a settlement opened. `refill_pending` / `refill_confirmed`: the deposit address is being funded with gas (TRON-origin deposits) before the funds move. `awaiting_credit`: parked until the workspace has gas credit to pay for it; it resumes on its own and uses no retry. `routing`: the funds are moving to the destination. `retrying`: an attempt failed and another is scheduled. `completed`: delivered. `failed`: retries ran out. `refunded`: Stridge returned the deposit instead of settling it, from `retrying`, `awaiting_credit` or `failed`. `completed` and `refunded` are final.\n",
             "example": "completed"
           },
           "created_at": {
@@ -3502,7 +3521,7 @@
           },
           "error": {
             "type": "string",
-            "description": "Failure reason when `status` is `failed`; empty otherwise.",
+            "description": "Why the last attempt failed or was refused, typically present while `status` is `retrying`, `awaiting_credit` or `failed`. Cleared when the settlement is retried or resumes; omitted when empty.\n",
             "example": ""
           },
           "deposit": {