Skip to content
aerandil.com
GitHub

What-if Request agent installation (rollup delta)

POST
/v1/actions/hospitality.action.request_agent_installation/whatif
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.request_agent_installation/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "allowed_workflow_keys": [ "example" ], "approval_policy": "example", "auth_mode": "none", "credential_reference": "example", "enabled_action_scopes": [ "example" ], "enabled_data_classes": [ "public" ], "enabled_function_scopes": [ "example" ], "enabled_read_scopes": [ "example" ], "enablement_note": "example", "expires_at": "2026-04-15T12:00:00Z", "installed_scope": "tenant", "installed_scope_ref_object_id": "example", "installed_scope_ref_object_type": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.agent_registry_entry" } }'

What-if projection of apply_hospitality_action_request_agent_installation — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.request_agent_installation:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid
params
required
object
allowed_workflow_keys
Optional workflow-key allowlist
Array<string>
approval_policy
Gates required for high-risk steps
auth_mode
required
How the installation authenticates at call time
string
Allowed values: none oauth_client_credentials oauth_delegated api_key_reference jwt_exchange mcp_oauth
credential_reference
Opaque pointer into an external secret manager
string
enabled_action_scopes
Subset of registry entry declared action scopes
Array<string>
enabled_data_classes
Subset of registry entry declared data classes
Array<string>
Allowed values: public operational guest_pii staff_pii payment_metadata regulated_health secrets
enabled_function_scopes
Subset of registry entry declared function scopes
Array<string>
enabled_read_scopes
Subset of registry entry declared read scopes; defaults to all of them
Array<string>
enablement_note
Free-text note
string
expires_at
Optional time-bound install
string format: date-time
installed_scope
required
Tenancy scope this installation grants access at
string
Allowed values: tenant brand portfolio property venue
installed_scope_ref_object_id
Required when installed_scope != tenant
string
installed_scope_ref_object_type
Required when installed_scope != tenant
string
return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.agent_registry_entry

Responses

Section titled “Responses”

200

Section titled “200”

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json
object
daily_rooms
required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>
object
business_date
required
string format: date
currency

ISO 4217, when the fold observed one.

string
property_id
required
string format: uuid
rooms_revenue_net_delta
required

Decimal, net rooms revenue delta.

string
rooms_sold_delta
required
integer format: int64
total_revenue_net_delta
required

Decimal, net total revenue delta.

string
Examplegenerated
{
  "daily_rooms": [
    {
      "business_date": "2026-04-15",
      "currency": "example",
      "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rooms_revenue_net_delta": "example",
      "rooms_sold_delta": 1,
      "total_revenue_net_delta": "example"
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Section titled “422”

Validation error — the apply would be rejected.